Skip to content

C2SIM OpenAPI Specification

The open-api-spec directory contains the official OpenAPI definition for the C2SIM RESTful interface.

This specification serves as the single source of truth for the API and is used to automatically generate both client and server stubs via standard OpenAPI code generation tools.

Viewing and Testing the Specification

You can explore and validate the C2SIM OpenAPI specification in the following ways:

  • Online: Upload or paste the specification into the Swagger Editor https://editor.swagger.io/

  • From a running C2SIM Server: Open the built-in UI at: /openapi-ui.html

This interactive interface allows you to:

  • Browse all available endpoints

  • Inspect request/response schemas

  • Execute test calls directly from the browser