https://github.com/bycorsanchez/showurswag
Show ur Swag is a web application that visualizes API documentation from Swagger YAML or JSON files, using the OpenAPI specification.
https://github.com/bycorsanchez/showurswag
documentation openapi-specification swagger swagger-ui
Last synced: about 1 year ago
JSON representation
Show ur Swag is a web application that visualizes API documentation from Swagger YAML or JSON files, using the OpenAPI specification.
- Host: GitHub
- URL: https://github.com/bycorsanchez/showurswag
- Owner: BycorSanchez
- License: apache-2.0
- Created: 2025-02-02T16:54:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-14T07:41:42.000Z (over 1 year ago)
- Last Synced: 2025-04-08T04:36:26.987Z (about 1 year ago)
- Topics: documentation, openapi-specification, swagger, swagger-ui
- Homepage: https://bycorsanchez.github.io/showurswag/
- Size: 450 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Show ur Swag
## Description
Show ur Swag is a web application that allows developers to instantly visualize API documentation from Swagger YAML or JSON files. Upload your file and the tool will render the corresponding Swagger UI for easy API exploration.
## Features
- **Drag & Drop Upload**: Easily upload your API definition by dragging and dropping your file.
- **Instant Swagger UI Rendering**: The API documentation is automatically displayed after upload.
- **URL-Based Sharing**: Compressed YAML/JSON can be shared via a URL parameter.
- **Lightweight & Client-Side**: Runs entirely in the browser with no backend required.
## Usage
1. Open the web page.
2. Drag and drop a `.yaml`, `.yml`, or `.json` file into the upload area.
3. The Swagger UI will appear displaying the API documentation.
4. To share, copy the generated URL containing the API definition.
## Technologies Used
- **HTML, CSS, JavaScript** for the front-end.
- **Swagger UI** for API documentation rendering.
- **LZ-String Compression** for URL-based sharing.
## License
This project is licensed under the Apache 2.0 License.