Challenge Overview
For this challenge, we'd like write a consolidated swagger spec for Member Services by reading the source code.
Here are the general requirements about the swagger api spec.
- The file should be named swagger.yaml, there exists a swagger.yaml in the source code, you can start from that.
- The spec should written in Swagger 2.0 with YAML format.
- The requests and responses should properly list all fields.
- For responses, you should cover all the cases, not just 200 status code, like 404
- Descriptions should be properly written for APIs, request input and responses etc
- please following the standard swagger 2.0 format, please raise any question if you are uncertain.
- You can use editor.swagger.io for validation
- For testing, you can use https://swaggerhub.com/, then make the swagger spec pointing to the prod server (https://api.topcoder.com)
About Source Code
The source code will be attached in forum, and you can start by looking at the classes in service/src/main/java/com/appirio/service/member/resources directory
Here are the general requirements about the swagger api spec.
- The file should be named swagger.yaml, there exists a swagger.yaml in the source code, you can start from that.
- The spec should written in Swagger 2.0 with YAML format.
- The requests and responses should properly list all fields.
- For responses, you should cover all the cases, not just 200 status code, like 404
- Descriptions should be properly written for APIs, request input and responses etc
- please following the standard swagger 2.0 format, please raise any question if you are uncertain.
- You can use editor.swagger.io for validation
- For testing, you can use https://swaggerhub.com/, then make the swagger spec pointing to the prod server (https://api.topcoder.com)
About Source Code
The source code will be attached in forum, and you can start by looking at the classes in service/src/main/java/com/appirio/service/member/resources directory