Skip to content

A simple Burp extension to convert API HTTP proxy requests into a JSON Swagger.

License

Notifications You must be signed in to change notification settings

YoruYagami/proxy2swagger

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌐 proxy2swagger

starsBDG licenseBDG languageBDG

proxy2swagger is a Burp Suite extension that generates Swagger (OpenAPI) specifications from proxy history, simplifying API documentation and testing.

✨ Features

  • πŸ›  Automatic Swagger Generation: Create Swagger (OpenAPI 3.0) documentation from in-scope proxy history.
  • πŸ–₯ UI for Swagger Management: Manage, edit and view the generated Swagger data via a user interface.
  • 🌐 Host Management: Update the host in the Swagger specification in case you change scope.
  • πŸ’Ύ Save and Load Swagger Files: Save the Swagger documentation to a file and load in-scope proxy history to update Swagger data.

πŸš€ Installation

  1. Download or Clone the Repository:
    git clone https://github.com/YoruYagami/proxy2swagger.git
  2. Download Jython Standalone:
  3. Compile the Extension: Use Jython, Java, or your preferred method.
  4. Load the Extension in Burp Suite:
    • Open Burp Suite.
    • Go to the "Extender" tab.
    • Click on the "Extensions" tab.
    • Click "Add" and select the Jython standalone JAR as the extension type.
    • Load the python extension file.

🀝 Contributing

Contributions are welcome! Please open an issue or submit a pull request.

πŸ“œ License

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

About

A simple Burp extension to convert API HTTP proxy requests into a JSON Swagger.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages