swagger-api / swagger-api/swagger-ui
the documentation of this project "swagger-api/swagger-ui" is really bad
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
the documentation of this project "swagger-api/swagger-ui" is really bad, it better find out the things in google. Why is there no examples?
i'm trying to figure out these things...
- I want to change the "tryout" button default hostname, how can i do that?
- It is possible to indicate in the url some config file, to change the aspect of the web?
swagger solve the torture of to document an api but you suffer the torture of swagger documentation
best regards.
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 by reviewing the existing Swagger UI documentation and configuration guidance. Focus on the two requested topics: changing the Try It Out button's default hostname and specifying a configuration file or web appearance settings in the URL. Done should include clear documentation and examples that answer both questions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation, web-dev
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100