https://github.com/rocket-org-imdeepmind/rocketredoc

RocketRedoc is a hosted Redoc UI instance that allows users to visualize and interact with OpenAPI documentation.
https://github.com/rocket-org-imdeepmind/rocketredoc

openapi redoc

Last synced: about 6 hours ago
JSON representation

RocketRedoc is a hosted Redoc UI instance that allows users to visualize and interact with OpenAPI documentation.

• Host: GitHub
• URL: https://github.com/rocket-org-imdeepmind/rocketredoc
• Owner: rocket-org-imdeepmind
• License: mit
• Created: 2024-02-25T19:00:00.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-06-04T16:33:21.000Z (5 months ago)
• Last Synced: 2024-06-05T17:48:43.076Z (5 months ago)
• Topics: openapi, redoc
• Language: TypeScript
• Homepage: https://redoc.rocketapi.net/
• Size: 80.1 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# RocketRedoc

RocketRedoc 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.

## How to Use

To utilize RocketRedoc, follow these simple steps:

1. Navigate to [RocketRedoc](https://redoc.rocketapi.net/).

2. Append `?url=` to the URL, replacing `` with the URL of your OpenAPI JSON schema. For example:

   ```

   https://redoc.rocketapi.net/?url=https://example.com/openapi.json

   ```

3. 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.

## Features

- **Easy Visualization**: RocketRedoc provides an intuitive interface for exploring OpenAPI documentation.

- **Hosted Solution**: Eliminates the need for setting up Redoc locally, making API exploration hassle-free.

## Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.

## Support

For any inquiries or support requests, please contact us at [email protected].

## License

This project is licensed under the MIT License - see the LICENSE file for details.