Postman is a tool to enable REST API development and collaboration. It is used by MantisBT team to share the API definitions and enables the community to experiment with the API. Download Postman.

The OpenAPI definition at api/rest/mantisbt_openapi.yaml is the only REST API contract. Contributors edit this file when adding or changing REST endpoints; the Postman collection and static documentation are generated from it.

Install the pinned generation tools with npm ci, then run npm run api:generate. This creates the collection at api/rest/generated/mantisbt.postman_collection.json and a static Scalar documentation site at api/rest/generated/docs/index.html, as well as a Bruno collection at api/rest/generated/bruno/.

Release builds created with build/buildrelease.py --docbook generate the same static site and include it at doc/en-US/rest-api/index.html. They also publish the Postman collection at doc/en-US/rest-api/mantisbt.postman_collection.json, alongside the Bruno collection at doc/en-US/rest-api/bruno/, the Administrator's Guide, and the Developer's Guide.

Import the generated collection together with the retained environment template at api/rest/env.postman_environment.json. The collection uses its {{url}} and {{token}} variables, which the environment supplies for a local MantisBT installation and user API token.