API Console feature
Open
Nobody has claimed this yet.
Type: Enhancement
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Implement API Console functionality.
Each method in ReDoc will have a button: “Try this method” which will open interactive console modal window.
There is the list of key features that should be implemented in the first version:
- Ability to send GET, POST, PUT, DELETE, UPDATE requests
- Ability to input/use/save authorization credentials
- Show UI for easy entering parameters for path, headers, query and body (payload) parameters
- UI should show selectbox for enums, checkboxes for boolean, text input for other simple types
- Request should be validated before send according to OpenAPI spec
- Support different environments (e.g. sandbox, dev, testing, etc) through OpenAPI vendor extension (each env will have unique base url and description) + ability to set default env specially for API-console
- For most parts response will be shown “as is”. JSON response will be only prettified (with possibility of collapsing). The other responses will be represented as strings.
- Show response headers that are documented in swagger. HTTP response headers that are not documented will be hidden under “Show undocumented response headers” button
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
The issue names no files, tests, or entry points, so first map the existing ReDoc API documentation UI and its OpenAPI request models. Define the console scope and design before implementation; done requires the listed request, authorization, parameter, validation, environment, and response-display behaviors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, react, typescript
- Domain
- api, documentation, frontend
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100