Skip to content

TASK: Add OpenAPI and Swagger UI standard for Spring services #82

Closed

Description

@ramioooz

Parent: STORY: Establish API contract and documentation standards

Define the Sprint 1 OpenAPI baseline for Spring Boot REST services.

Acceptance criteria

  • Spring Boot services use the approved springdoc-openapi integration.
  • Each contract has an explicit title, description, and semantic contract version.
  • Each service exposes its contract at /v3/api-docs inside the cluster.
  • API Gateway exposes the contract through /admin/docs/{service}/v3/api-docs.
  • Documented error responses use application/problem+json.
  • Pagination and monetary fields follow the platform conventions.
  • Examples use synthetic data and contain no credentials or customer information.

Security schemes and environment-specific production access controls are covered by .github#85 in Sprint 4. Kafka/AsyncAPI contracts are covered by .github#86 and .github#104 in Sprint 3.

Activity

  1. added theissue type on Aug 2, 2026
  2. self-assigned this
    on Aug 3, 2026
  3. ramioooz commented on Aug 3, 2026

    @ramioooz
    MemberAuthor
  4. ramioooz commented on Aug 3, 2026

    @ramioooz
    MemberAuthor

    Spring REST/OpenAPI baseline completed. Customer and Account Services now publish explicit OpenAPI metadata and tests through customer-service#34 and account-service#32.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions