Skip to content

BycorSanchez/showurswag

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 

Repository files navigation

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.

About

Show ur Swag is a web application that visualizes API documentation from Swagger YAML or JSON files, using the OpenAPI specification.

Topics

Resources

License

Stars

Watchers

Forks

Contributors