API Console feature

[RomanHotsiy]

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

[RomanHotsiy]

A few mockups:

[SebastianStehle]

Do you have a timeline for this feature? If you are done with it, SwaggerUI should be replaced by Redoc as the official solution ;)

[RomanHotsiy]

@SebastianStehle can't promise anything. It is on our list but before we have a few other things to implement. I will update the roadmap shortly.

Hopefully, we will get this ready in 3-4 months

[sixers]

Hey, any update on this?

[RomanHotsiy]

API Console is one of the priorities now. But so far we haven't started working on that :(
This seems to be the next big task on our roadmap.
I will post here once we start work on this.

[adamaltman]

It may be good if the console can also send PATCH requests too.

[dolmen]

About the support for "different environments" in the description of this issue, I don't think this should be a priority: the host and the basePath are specified in the Swagger spec and allowing to switch environments would imply to override the information from the spec. But there would be a much simpler to way to have this feature: have multiple instances of ReDoc with its own spec with the specialized spec with the specific host/basePath settings. That's how I'm handling multiple environments with swagger-ui right now.

Note that sandbox/dev/testing environments are usually not information you want to expose (and accidentally leak), so using a vendor extension of the spec does not seem to be the right place.

[gembin]

It will be awesome to have API Console. +1

[pkvenu]

+1 for API Console. Do you guys have a timeline for this?

[Rikhart]

+1 for API Console.