https://github.com/rocket-org-imdeepmind/swaggerweb
RocketSwagger is a hosted Swagger UI instance that allows users to visualize and interact with OpenAPI documentation.
https://github.com/rocket-org-imdeepmind/swaggerweb
openapi swagger swagger-ui
Last synced: 6 months ago
JSON representation
RocketSwagger is a hosted Swagger UI instance that allows users to visualize and interact with OpenAPI documentation.
- Host: GitHub
- URL: https://github.com/rocket-org-imdeepmind/swaggerweb
- Owner: rocket-org-imdeepmind
- License: mit
- Created: 2024-02-11T08:46:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T18:00:42.000Z (11 months ago)
- Last Synced: 2025-03-10T18:45:02.426Z (11 months ago)
- Topics: openapi, swagger, swagger-ui
- Language: TypeScript
- Homepage: https://swagger.rocketapi.net
- Size: 240 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SwaggerWeb
SwaggerWeb is a hosted Swagger 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 SwaggerWeb, follow these simple steps:
1. Navigate to [SwaggerWeb](https://swagger.rocketapi.net/).
2. Append `?url=` to the URL, replacing `` with the URL of your OpenAPI JSON schema. For example:
```bash
https://swagger.rocketapi.net/?url=https://example.com/openapi.json
```
3. Hit Enter or navigate to the modified URL.
You will now be directed to a Swagger UI instance displaying the documentation specified by the provided OpenAPI schema URL.
## Features
- **Easy Visualization**: SwaggerWeb provides an intuitive interface for exploring OpenAPI documentation.
- **Interactive Documentation**: Users can interact with API endpoints directly within the Swagger UI.
- **Hosted Solution**: Eliminates the need for setting up Swagger 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 [hello@rocketapi.net](mailto:hello@rocketapi.net).
## License
This project is licensed under the MIT License - see the LICENSE file for details.