Rest API Documentation

Documentation of a REST API is crucial for developers and testers to clearly understand the behavior provided by it. The tool chosen to document our API was Swagger. Swagger is a framework that helps in describing, consuming and visualizing the services of a REST API. An important feature found in Swagger is the API specification which consists of determining the data models that will be understood by the API and the functionalities present in the API.

To access the RestAPI documentation and get more detailed information about the methods that can be invoked just type RestAPI Endpoint/api-docs/ in your browser.

If you are running the The URL for the admin portal RestAPI documentation will be https://hostname/api-adminportal/api-docs/ . And the URL for the user portal RestAPI documentation will be https://hostname/api-portal/api-docs/.