Ana içeriğe geç

OpenAPI Specification

Overview​

The Apinizer Management API provides OpenAPI (Swagger) specification files for programmatic access to API definitions.

The specification file published with this documentation is generated from a running Apinizer Manager — its source is the /apiops/openapi.yaml endpoint — and it is regenerated for every release, so it matches the Management API contract of the documented version. It is never edited by hand.

Accessing the Specification​

The Manager exposes the APIops OpenAPI document through SpringDoc. JSON is served at the base path; YAML is available by appending .yaml. There is no separate /apiops/openapi.json endpoint.

JSON Specification​

Download or fetch the OpenAPI JSON specification:

https://{management_console_url}/apiops/openapi

Use this URL with tools that import a spec from a link (Postman, Insomnia, OpenAPI Generator, and similar).

YAML Specification​

Download the OpenAPI YAML specification:

https://{management_console_url}/apiops/openapi.yaml

Error Responses​

Management API error bodies follow RFC 7807 (type, title, status, path, message). For client errors (4xx) the detail field carries the product's own message and message carries a translatable key such as error.portalContextRequired. For server errors (5xx) the body carries only the generic key error.http.<status> — the underlying cause is written to the Manager log and never returned to the caller.

Using the Specification​

Generate Client Libraries​

Use tools like OpenAPI Generator to generate client libraries in various languages:

openapi-generator generate \
  -i https://demo.apinizer.com/apiops/openapi \
  -g python \
  -o ./apinizer-client

You can pass the YAML URL (.../openapi.yaml) instead when your toolchain prefers YAML.

API Testing​

Import the OpenAPI specification into API testing tools like Postman or Insomnia for automated testing.

Documentation Generation​

Use tools like Swagger UI or ReDoc to generate interactive documentation.

Specification Version​

The current OpenAPI specification version is 3.0.

En son tarihinde güncellendi