Challenge Overview
Welcome to Hercules Base Libraries - Swagger Specification Part 2 contest. As part of this contest, you need to create a Swagger Specification for an existing application.
Contest Details
We have a suite of services called BaseLibraries. We would like you to create a Swagger based specification for the application.
You will be creating the swagger specification for the API endpoints that the methods call. Your tasks as part of this contest will thus be:
1. Go through the following services (only the ones listed below are in scope):
- EinsteinService
- GrandSlamService
- NGBService
- PartnerServiceGateway
2. Identify the different endpoints that are called by each service. Each service contains multiple methods which in turn call a very specific endpoint. They either pass different values (query or url params) to the endpoint or process the response differently. You need to document each endpoint called, the query params (or request body) that are passed and the response received from the endpoints.
3. Call each endpoint in POSTMAN or implement the services locally and capture the responses. This step is only for your understanding. You are not required to provide any additional documentation besides the one in Step 4 below.
4. Create a Swagger Specification for the endpoints identified.
Points to Note
- We already launched a contest earlier to create the swagger specification for an earlier set of services. You are expected to follow the conventions used in the provided specification.
- Do not rely on the tests for the services. They do not always run successfully. However, you can certainly use that as a starting point.
- It is possible that multiple methods call the same endpoint with different query params. In such a case, it is acceptable (not necessary though) to document the endpoint only once, but you need to specify all the query params applicable for that endpoint.
- You need to document which services or endpoints do not work. Please update the existing README.txt file in the swagger folder. DO NOT create multiple README files.