OpenAPI Export

API Browser describes your API as an OpenAPI 3.1 document, made afresh each time from the resources as they are.

Downloading#

In the admin, use the OpenAPI (JSON) and OpenAPI (YAML) buttons; the admin addresses need you to be signed in. The public addresses are open to anyone once the public browser is on.

What it holds#

• servers: your site's /api address.
• For each resource, its search and record paths with their operations: get, post, put and delete.
• The query parameters of each search, with what they do.
• A schema per resource with the keys of its JSON, their types, and an example from a real record.
• The Omeka-Total-Results and Link headers of searches, Location of creates, and the error statuses.
• An API key scheme: the key query parameter, optional for reads (public records need none) and required for changes.
• For POST /files, the multipart upload: the file in a file part and its JSON in a data part.

Using it#

Import it into Postman, Insomnia or Bruno, generate a client library with OpenAPI Generator, publish it with Swagger UI or Redoc, or give it to an AI tool so it knows your API. Download it again after installing or removing a plugin that adds resources.