OpenAPI Specification

Overview

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

Accessing the Specification

Interactive Documentation

Visit the interactive OpenAPI documentation at:

https://{management_console_url}/apiops/openapi

YAML Specification

Download the OpenAPI YAML specification:

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

JSON Specification

Download the OpenAPI JSON specification:

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

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.yaml \
  -g python \
  -o ./apinizer-client

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.