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

Generating API Docs on the Documentation site #248

Open
deshetti opened this issue Aug 16, 2022 · 0 comments
Open

Generating API Docs on the Documentation site #248

deshetti opened this issue Aug 16, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@deshetti
Copy link
Member

Looks like the swaggo/swag that we are using to generate the Swagger client doesn't support OpenAPI spec. I thought that will not work with ReDoc to autogenerate the API Docs using either the swagger.json or swagger.yaml files. There is an open issue to support OpenAPI spec for over three years 🙂 swaggo/swag#386

But interestingly, I checked it on ReDocs site to see if our spec is generating the API docs and it looks fine to be from a quick glance: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/factly/kavach/fix/space-conflicts/server/docs/swagger.json

Now what we could do is use this preset in Docusaurus to generate the API docs:
Documentation: https://redocusaurus.vercel.app/docs
Package: https://www.npmjs.com/package/docusaurus-plugin-redoc

@deshetti deshetti added the documentation Improvements or additions to documentation label Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants