Skip to content

MichaelGombos/course-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Course-API

Course-API is a RESTful web service built with the spring framework.

This web service can be run without a container, and executed as a jar file in the enviornment of your choice.

Installation

You can download this web service as a .rar, by heading to the releases tab.

Alternatively, you can package it yourself using maven. To install using maven, navigate to the installed directory and run,

mvn clean install

Usage

Run the .rar executable

Send HTTP requests to your database

I will be using Postman in these examples, but any tool for simulating HTTP requests will work!

In this REST API, topics are mapped to courses in a many to one relationship. (one topic can have many courses)

POST

Example of entering a Topic into our database post request, topic Example of entering a Course into our database (Remember, Many to One!) post request, course

PUT

Example of updating a course in our database put request, course

GET

Example of retrieving information about a single topic in our database get request, topic single Example of retrieving information about ALL topic in our database get request, topic many

DELETE

delete request, topic one Example of removing a topic from our database

License

The Unlicense