swaggerific

Overall Downloads on github:

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

Install via Homebrew (macOS)

Swaggerific is available as a Homebrew Cask for macOS (Intel x86_64). The app is signed and notarized with an Apple Developer ID certificate in a DMG package.

1. Tap this repository:

brew tap ozkanpakdil/swaggerific https://github.com/ozkanpakdil/swaggerific

2. Install the app:

brew install --cask swaggerific

• Update to the latest build:

brew upgrade --cask swaggerific

• Uninstall:

brew uninstall --cask swaggerific

Notes:

• This cask targets Intel (x86_64) macOS builds.
• The app is signed and notarized, so it should open without Gatekeeper warnings.
• It pulls the latest prebuilt DMG from the latest_macos GitHub release.

Packaging artifacts

The macOS packaging script build-macos-arm64.sh places generated artifacts under the staging/ directory (DMG, .pkg, and installer .pkg). The staging/ folder is ignored by Git.

Local Signing and Notarization

To run the local build with signing and notarization:

1. Ensure your Developer ID certificates are in your Keychain.
2. Set the following environment variables (e.g., in your ~/.zshrc):

   export APPLE_API_KEY_ID="your_key_id"
   export APPLE_API_ISSUER_ID="your_issuer_id"
   # The script expects the .p8 key in certificates/ or set:
   export APPLE_API_KEY_PATH="/path/to/your/AuthKey_XXXX.p8"

3. Run ./build-macos-arm64.sh

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

Run tests in macOS

mvn -Djava.awt.headless=false -Dtestfx.robot=glass -Dsurefire.parallel=none test

Run agent

mvn gluonfx:runAgent