- Swagger UI -
http://localhost:8080/swagger-ui.html- interactive API documentation and testing, generated by springdoc-openapi. Use Authorize to paste an access token from/api/v1/auth/login. - OpenAPI 3 document -
http://localhost:8080/v3/api-docs- machine readable description of the API, for client generators and tools such as Postman or Insomnia. - Both are available in every profile except
production, where they are switched off (springdoc.api-docs.enabledandspringdoc.swagger-ui.enabled). - Postman Collection - online, with code snippets generated in cURL, jQuery, Ruby, Python Requests, Node, PHP and Go.
- Postman Collection for offline testing:
documents/Spring Boot Application Template.postman_collection.json. - Javadoc is generated in
target/reports/apidocswith:
./mvnw javadoc:javadoc