API Documentation with Swagger (OpenAPI)

FFmate provides comprehensive API documentation using the Swagger. This interactive documentation allows you to easily explore, understand, and test FFmate's REST API directly from your web browser.

How to Access the Swagger UI

Once your FFmate server is running, you can access the Swagger UI in your web browser at the following URL:

http://<your-ffmate-host>:<port>/swagger/index.html

• Replace <your-ffmate-host> with the hostname or IP address where FFmate is running (e.g., localhost if running locally).
• Replace <port> with the port number FFmate is listening on (default is 3000).

Default URL

If you're running FFmate locally on the default port, just copy the URL below into your browser's address bar to access the Swagger (OpenAPI) interface:

http://localhost:3000/swagger/index.html

Postman Collection

Prefer testing APIs in Postman?

Click the button below to open the official FFmate Postman collection and start exploring the API with ready-made requests—no setup required.