vmdef
commented
3 years ago We'll use version 3.0.3 (https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md), writing the specification in YAML (https://yaml.org/spec/). We can use the Swagger Tools:
- Swagger Editor (https://editor.swagger.io/): for designing and describing the app REST API.
- Swagger Codegen (https://github.com/swagger-api/swagger-codegen): Spring-based API interface generation, using the Gradle Swagger Generator Plugin (https://github.com/int128/gradle-swagger-generator-plugin).
- Swagger UI (https://swagger.io/swagger-ui/): API documentation generation.
We'll follow a design-first approach for implementation. We will make use of the OpenAPI Specification (OAS) for first designing the API.