RedocWeb is a hosted Redoc UI instance that allows users to visualize and interact with OpenAPI documentation. By simply passing the URL of an OpenAPI JSON schema, users can explore APIs effortlessly.
To utilize RedocWeb, follow these simple steps:
-
Navigate to RedocWeb.
-
Append
?url=<open_api_schema_url>to the URL, replacing<open_api_schema_url>with the URL of your OpenAPI JSON schema. For example:https://redoc.rocketapi.net/?url=https://example.com/openapi.json -
Hit Enter or navigate to the modified URL.
You will now be directed to a Redoc UI instance displaying the documentation specified by the provided OpenAPI schema URL.
- Easy Visualization: RedocWeb provides an intuitive interface for exploring OpenAPI documentation.
- Hosted Solution: Eliminates the need for setting up Redoc locally, making API exploration hassle-free.
Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.
For any inquiries or support requests, please contact us at [email protected].
This project is licensed under the MIT License - see the LICENSE file for details.