OpenAPI Specification

The MaxConf API is built with FastAPI, which auto-generates an OpenAPI 3.0 specification from the source code. This serves as the machine-readable contract for all endpoints.

Accessing the spec

Method	URL	When to use
Interactive Swagger UI	http://localhost:7071/docs	Local development - try endpoints interactively
ReDoc	http://localhost:7071/redoc	Local development - read-only formatted view
Raw JSON (local)	http://localhost:7071/openapi.json	Local development - raw spec for tooling
Published snapshot	/openapi-spec.json	Reference - spec snapshot published with docs

Running locally

Prerequisites

The Function App requires a packages/pexip-sdk/local.settings.json with Pexip OAuth credentials and Log Analytics keys before it can start. See Developer Setup - Environment variables for the complete template and instructions for fetching secrets from Key Vault.

# From the repository root
nx run pexip-sdk:serve

Then open http://localhost:7071/docs in your browser.

Tip

The local Swagger UI allows you to test all endpoints without authentication (Function-level auth is disabled locally). This is the fastest way to explore the API during development.

Published snapshot

A static snapshot of the OpenAPI spec is published with this documentation site at /openapi-spec.json. This may lag behind the current source code - always prefer the local dev server for the latest spec.

Using the spec with tools

The OpenAPI JSON can be imported into:

• Postman - import as a collection for manual testing
• Azure API Management - import to update API policies and gateway config
• Code generators - generate client SDKs in any language (e.g., openapi-generator-cli)