You can download the latest version from Github releases Follow here for new releases.
A user interface (UI) designed to interact with APIs using Swagger or OpenAPI jsons.
- 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
- SOLID principles applied throughout the codebase
- Clean separation between UI and HTTP service layers
- Modular design with well-defined interfaces
- Comprehensive error handling and logging
- Unit and UI tests for critical functionality
- Authentication support (OAuth, API keys, Basic Auth)
- Request history and favorites
- Environment variables and request chaining
- Team collaboration features
- Performance metrics and analytics
We've added a convenient bash script to run the application without requiring Maven:
# Make the script executable (first time only)
chmod +x run.sh
# Run the application
./run.sh
The script will:
- Check if Java 17+ is installed
- Look for the JAR file in the target directory
- Build the project if the JAR doesn't exist (requires Maven)
- Run the application with all necessary JVM arguments
For easy distribution to users, you can create a zip package:
# Make the script executable (first time only)
chmod +x package.sh
# Create the distribution package
./package.sh
This will create a zip file in the dist
directory containing:
- The application JAR
- Run scripts for Linux/macOS (run.sh) and Windows (run.bat)
- README with instructions
- Required resources
Users can simply download the zip, extract it, and run the application using the provided scripts.
mvn gluonfx:build gluonfx:nativerun
There are classes needs to be in the list of reflection list of the compiler(which was in the pom.xml before check 'git history'), that list can be generated from command below, that will update the jsons under META-INF/native-image
./mvnw gluonfx:runagent