RESTFul API Documentation

Our REST API Documentation is supplemented by Swagger-UI here:

http://tutorme-ecse321-group3.herokuapp.com/swagger-ui.html

The documentation interface provides the following:

• List of APIs
  • Path variables and Query Parameters included
  • Sample Response
  • Sample Response codes
• An interface to carry out integration testing by executing the API with a sample input.

Why we used Swagger-UI

We wanted to spend more development effort on application logic rather than "reinventing the wheel". Following this concept and that of working software over comprehensive documentation, we opted to use Swagger-UI to have a neat, detailed RESTFul API documentation that is maintained automatically.

Swagger UI Features

1. Go to http://tutorme-ecse321-group3.herokuapp.com/swagger-ui.html
2. The URL to GET a course is specified by the /api/course url extension to the base URL (tutorme-ecse-group3.herokuapp.com/) as shown.

3. Clicking on a specific API loads more features:

The request parameters are specified once clicking on the specific API. It is specified whether the parameter is a query parameter or path variable.

4. Sample responses of the API are shown in the modal