OpenAPI Documentation

We provide automatically generated OpenAPI documentation for the DSP API. The OpenAPI specification is available both as YAML specification files and through Swagger UI.

The documentation for the version currently deployed in production can be found at:

• OpenAPI Specification (YAML)
• Swagger UI

The documentation for the current main branch can be found at:

• OpenAPI Specification (YAML)
• Swagger UI

Documentation for any other server is available on the according routes:

• OpenAPI Specification (YAML): /api/docs/docs.yaml
• Swagger UI: /api/docs/

With the API URL prefixed. That is: http://localhost:3333 when running the API locally, or https://api.{server}.dasch.swiss when running on a server.