OpenAPI Specification & Swagger UI

FOSPS uses OpenAPI Specification (OAS) as the standard for API documentation, exposed through Swagger UI deployment.

Purpose

OpenAPI specifications provide:

• Standardized API documentation
• Interactive API exploration
• Client code generation capabilities
• Contract-first development approach

Swagger UI

The Swagger deployment allows developers to:

• Browse all service endpoints
• Understand request/response schemas
• Test API calls interactively
• View authentication requirements

Required for All Services

All FOSPS service layer components must document their APIs using OpenAPI, including:

• Preprocessors: /preprocess endpoint
• Connectors: Resource retrieval endpoints
• Focusing Manager: Focusing workflow APIs
• Supporting Material Matchmaking: Matchmaking API

Example Specifications

• Preprocessor API: preprocessing-service-example/openapi.yaml

Integration

OpenAPI specs integrate with:

• Istio for routing and exposure
• Kubernetes service definitions
• Documentation generation tools

Related Concepts

• FOSPS - Platform architecture
• Architectural Layers - Service layer
• Preprocessor - Example service with OpenAPI
• Connectors - Services requiring documentation