Skip to content

feat: Expose multiple Swagger UIs on different URLs, each representing different features/modules.Β #1598

@RinkalBhojani

Description

@RinkalBhojani

βœ… Preliminary Checks

🧩 Problem Statement

Currently, the Swagger documentation in credebl/platform exposes all APIs in a single consolidated view. As the number of APIs grows across multiple domains (e.g., DIDComm, OID4VC, utilities), this leads to:

  • Difficulty in quickly locating relevant APIs
  • Increased scrolling and navigation time
  • Reduced developer experience, especially for new integrators

For example:

  • DIDComm APIs (connections, credentials, verification) are mixed with
  • OID4VC / OID4VP APIs and
  • Utility APIs (geolocation, ledger, webhook, etc.)

This lack of logical segregation makes the documentation harder to use and maintain.

πŸ’‘ Proposed Solution

Introduce multiple Swagger UI endpoints, each representing a logical grouping of APIs based on feature/domain.

Suggested grouping:

  • DIDComm APIs
  • Connections
  • Credential exchange

Proof/verification

  • OID4VC APIs
  • OID4VC issuance
  • OID4VP presentation flows

Utility APIs

  • Geolocation
  • Ledger interactions
  • Webhooks
  • Miscellaneous/shared services

http://localhost:5000/api/didcomm
http://localhost:5000/api/oid4vc

πŸ”„ Alternatives Considered

No response

πŸ“Ž Additional Context

No response

βœ… Acceptance Criteria

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementImproving existing code or adding enhancementgood first issueGood for newcomerstriageNeeds discussion

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions