New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Write API specifications #1

Open

genericSpecimen opened this issue Sep 28, 2021 · 1 comment

Labels

Contributor

genericSpecimen commented Sep 28, 2021

Write API specifications to provide an overview of the functionality of the API, and the expected results.

Suggested fields:

API name and version
Description of all resources, endpoints, HTTP methods, all input parameters, response codes

genericSpecimen added the documentation label

Contributor Author

genericSpecimen commented Nov 1, 2021 •

edited

Loading

Trying a 'Code First' API Documentation approach with springdoc-openapi and special annotations - bea2ab5

Auto-generated API spec is currently available at the following links after application start-up:

Swagger UI: http://localhost:8080/swagger-ui.html
OpenAPI v3 (JSON): http://localhost:8080/v3/api-docs

genericSpecimen added a commit that referenced this issue


          added api endpoint-component specifications, #1

be7b111

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment