Skip to content
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.

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

Add documentation in OpenAPI format using adonis5-swagger #185

Open
Frewacom opened this issue Jul 12, 2021 · 0 comments
Open

Add documentation in OpenAPI format using adonis5-swagger #185

Frewacom opened this issue Jul 12, 2021 · 0 comments
Labels
api Improvement or changes to the API documentation Improvements or additions to documentation

Comments

@Frewacom
Copy link
Member

The OpenAPI format is widely accepted as the standard documentation method for API's and have a wide selection of front end generators, e.g. Redocly.

https://github.com/reg2005/adonis5-swagger

I have looked at a few different front end generators, and Redocly is the one that seems the best, both in design and functionality.

Tasks

  • Install and setup adonis5-swagger
  • Document all of the endpoints 🙉
  • Install Redocly and serve the static files at e.g. <domain>/docs (from the public directory)
    Another solution would be to deploy the docs separately like we are currently doing, but this will require more work to make it fully automated.
  • Automate the docs generation in staging and production so that it is automatically available after deploying.
@Frewacom Frewacom added documentation Improvements or additions to documentation api Improvement or changes to the API labels Jul 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Improvement or changes to the API documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant