A more elegant API Documentation Viewer
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- TypeScript
- Stars
- 51
- Forks
- 105
- Avg merge
- 10h 35m
- Merged PRs (30d)
- 17
Description
Currently we use the default Swagger UI for our API Documentation which doesn't look great
We should investigate an alternative design.
Prebuilt alternatives to consider:
- Redocusaurus: https://github.com/rohit-gohri/redocusaurus
Not if we do use a third party module, it has to be OSS and with an acceptable license (preferably Apache 2.0 or MIT).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked API Documentation page to understand the current Swagger UI presentation, then review Redocusaurus as a possible alternative. Check that any selected third-party module is open source with an acceptable license, preferably Apache 2.0 or MIT. Done means an alternative design has been investigated and selected for the API documentation viewer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- design, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100