Skip to content

Add OpenAPI specification and Swagger UI for REST API documentation #11

@treblereel

Description

@treblereel

Context

Part of epic #1 — Build production-ready REST microservice with k8s deployment on top of casehub-engine. API consumers need auto-generated documentation to understand endpoints, request/response schemas, and integration patterns.

What

Configure OpenAPI spec generation and Swagger UI:

  • /q/openapi — OpenAPI 3.0 spec (JSON/YAML)
  • /q/swagger-ui — interactive Swagger UI for testing endpoints
  • Annotate all REST endpoints with proper OpenAPI metadata

Acceptance Criteria

  • OpenAPI spec available at /q/openapi in both JSON and YAML formats
  • Swagger UI accessible at /q/swagger-ui with all API v1 endpoints
  • All endpoints documented with @operation, @apiresponse, @parameter annotations
  • Request/response schemas include descriptions and examples
  • Error responses (400, 404, 409, 500) documented with RFC 7807 problem details schema
  • API info section includes title, version, description, contact
  • Integration tests verify OpenAPI spec is valid and includes all endpoints

Notes

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions