swaggerific

Overall Downloads on github:

You can download the latest version from Github releases Follow here for new releases.

Requirements

• Java Development Kit (JDK) 17 or higher
• JavaFX (included in the distribution)

A user interface (UI) designed to interact with APIs using Swagger or OpenAPI jsons.

Cool interview

Features:

• The UI is built using JavaFX with modern styling and responsive design
• Comprehensive error handling with user-friendly error messages
• Retrieve and load Swagger/OpenAPI JSON to fetch API documentation
• Display a tree view of endpoints on the left-hand side for easy navigation
• Select specific endpoints and view their details
• Support for all HTTP methods (GET, POST, PUT, DELETE, etc.)
• Input data via form fields or JSON editor with syntax highlighting
• Execute API requests and view formatted responses (JSON/XML)
• Dropdown/combobox selection for parameters with enumerated values
• Auto-completion for brackets and quotes in the JSON editor
• Syntax highlighting for request and response bodies
• Raw response view for debugging purposes

Architecture:

• SOLID principles applied throughout the codebase
• Clean separation between UI and HTTP service layers
• Modular design with well-defined interfaces

Running the Application

From Distribution Package

1. Download the latest release from GitHub Releases
2. Extract the ZIP file
3. Run the application using the provided script:
   • Linux/macOS: ./run.sh
   • Windows: run.bat

From Source

1. Clone the repository
2. Build with Maven: mvn package
3. Unzip the generated swaggerific-X.Y.Z.zip file under target/dist
4. Run the application using the provided script:
   • Linux/macOS: ./run.sh
   • Windows: run.bat