BuildForSDG / BuildForSDG/Team-006-Backend
[docs] - Swagger Open API documentation
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
### Description
To enable end users/API consumers know available endpoints, relevant parameters, valid data and their types, url and request methods we need a documentation for the API.
This API documentation will be generated using swagger tools, particularly `swagger-jsdoc` and `swagger-ui-express` and will be hosted on /api-docs. Alternative API documentation tools can be used.
- https://github.com/scottie1984/swagger-ui-express
- https://github.com/Surnet/swagger-jsdoc
**Support Articles:**
- https://itnext.io/setting-up-swagger-in-a-node-js-application-d3c4d7aa56d4
- https://medium.com/@dlowkeen/auto-generating-swagger-documentation-for-your-node-api-c806cedbdd3e
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the API endpoints and the swagger-jsdoc and swagger-ui-express guidance linked in the issue. Document available endpoints, parameters, valid data and types, URLs, and request methods, then make the generated documentation available at /api-docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nodejs, openapi
- Domain
- api, backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100