API documentation (PRO)

A ready description of your site's public API — not written by hand but assembled from whatever is published right now.

PageBlocks → Constructor → API documentation.

The tab hosts Swagger UI. It draws on two sources:

• tables whose API tab has the "serve over API" box ticked;
• objects declared in core/App/api.php.

Calling from right here

Press Authorize, paste a token from the API tokens tab, and you can call the methods without leaving the manager. It is the quickest way to confirm a client will see the same thing.

The specification as a file

/mgr/pb/openapi.json?ctx=mgr

Plain OpenAPI: opens in Postman, feeds a client generator. Which means a front-end developer gets a typed client without hand-writing a single endpoint.

The description cannot go stale

Nobody writes or maintains it: tick a table for the API and it appears, untick and it is gone. There is nothing here to drift out of step with reality.

What to publish and how is in REST API.