Getting Started

Getting Started

Install

macOS (Apple Silicon, arm64) via Homebrew

1. Tap the repo:

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

2. Install the app under your user Applications folder:

   brew install --cask swaggerific --appdir=~/Applications

3. Later updates:

   brew upgrade --cask swaggerific

4. If macOS Gatekeeper blocks launch for an unsigned build:

   # Option A: install without quarantine
   brew uninstall --cask swaggerific
   brew install --cask --no-quarantine swaggerific --appdir=~/Applications
   
   # Option B: remove quarantine on the existing app bundle
   xattr -dr com.apple.quarantine ~/Applications/swaggerific.app

Other platforms

• Download the latest release from GitHub Releases and run the included launcher scripts.
• Requirements: JDK 17+ (JavaFX is bundled with the distribution build).

Launch

• macOS: open Swaggerific from Applications.
• From source: mvn package, unpack the dist ZIP, then run ./run.sh (or run.bat on Windows).

First run checklist

• Optional: Open Settings (Ctrl+S on Windows/Linux, Cmd+S on macOS) to adjust theme (Light/Dark), request timeout, SSL verification, and history settings.
• Optional: Configure Proxy/Certificates if your network requires it.

Next: Open a Swagger/OpenAPI schema.