Allow running HTTP commands from the API documentation
Open
Nobody has claimed this yet.
api-documentation
enhancement
- Dominant language
- Go
- Stars
- 323
- Forks
- 133
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 2
Description
The new API documentation website (#182) does not allow running HTTP commands from the browser like the previous one used to.
Users can import the OpenAPI definition from their HTTP client (Postman, Insomnia, etc.) which is a better developer experience IMHO. However we should still consider adding this feature back to the API documentation website.
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 API documentation website introduced in issue #182 and compare it with the previous site that supported running HTTP commands. Determine the intended browser-based behavior and how completion would be verified; the issue does not name files, tests, or a specific implementation path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100