swagger-api / swagger-api/swagger-codegen
Generated README.md has wrong instructions to run the server
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
The generated README.md in the ## Usage section states that:
## Usage
To run the server, please execute the following from the root directory:
pip3 install -r requirements.txt
python3 -m swagger_server
and open your browser to here:
http://localhost:8080/ui/
but the ui URL does not seem to work as the /ui path does not seem to exist and returns:
{
"detail": "The requested URL was not found on the server. If you entered the URL manually please check your spelling and try again.",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}
##### Suggest a fix/enhancement
Please update the generated README.md with correct instructions
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 generated README.md's Usage section and run the documented pip3/python3 commands to confirm the /ui/ 404. Trace the generator template that produces this section; done means the generated instructions point to a working URL and no longer direct users to the missing /ui path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100