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.

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

Add Swagger documentation for the API #40

Open
ngosang opened this issue Dec 16, 2020 · 0 comments
Open

Add Swagger documentation for the API #40

ngosang opened this issue Dec 16, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
3.4.0

Comments

@ngosang
Copy link
Member

ngosang commented Dec 16, 2020

The idea is to create a new endpoint in the server called swagger or doc to display Swagger UI. It's a Web UI to document and test all endpoints. Example demo => https://petstore.swagger.io/#/

https://blog.cloudboost.io/adding-swagger-to-existing-node-js-project-92a6624b855b
@ngosang ngosang added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 16, 2020
@ngosang ngosang added this to the 1.2.4 milestone Jan 18, 2021
@ngosang ngosang modified the milestones: 1.3.0, 1.4.0 May 28, 2021
@ngosang ngosang modified the milestones: 2.0.0, 2.1.0 Oct 17, 2021
@ngosang ngosang modified the milestones: 2.1.0, 3.0.0 Dec 12, 2021
@ngosang ngosang modified the milestones: 3.0.0, 3.2.0 Jan 5, 2023
@walester walester mentioned this issue Nov 11, 2023
Open
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
3.4.0
Development

No branches or pull requests
1 participant
@ngosang