feat: Serve OpenAPI spec via Swagger UI at /docs

[dotunv]

Overview

Add a Swagger/OpenAPI UI endpoint that serves the existing docs/openapi.yaml as an interactive API explorer.

Motivation

The README has a full API reference and docs/openapi.yaml exists, but there is no way for developers to interactively explore and test the API from a browser. Serving the OpenAPI spec via Swagger UI dramatically improves the developer experience.

Proposed Design

1. Add GET /docs endpoint serving Swagger UI
2. Swagger UI loads the OpenAPI spec from GET /docs/openapi.yaml
3. Serve the spec file from the docs/ directory
4. Swagger UI is available in all environments (not just development)
5. Add a link to the docs endpoint in the API root response

Acceptance Criteria

• GET /docs returns an interactive Swagger UI page
• Swagger UI loads and renders the OpenAPI spec correctly
• All API endpoints are documented and explorable via the UI
• Try It Out feature works for authenticated endpoints (supports API key input)
• /docs endpoint does not require authentication to view
• OpenAPI spec is served from GET /docs/openapi.yaml
• Response includes a link to /docs in the root API response

[Horlarolowo123]

@Horlarolowo123 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hello Maintainer, I’ve carefully reviewed the issue and have a clear understanding of the requirements. I’m ready and confident to take it on. Kindly assign the issue to me.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Horlarolowo123 to this issue.

[boluxx123]

@boluxx123 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

I’d be happy to take this on. I’m confident I can get it fixed within the next 30mins . Kindly assign it to me.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @boluxx123 to this issue.

[probablyABug]

@probablyABug has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

hi, i would like to work on this.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @probablyABug to this issue.

[alaminharuna-dev]

@alaminharuna-dev has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi, I’ve checked the issue details and understand the expected behavior. I’d like to take a closer look at the implementation.

ℹ️ Repo Maintainers: To accept this application, review their application or assign @alaminharuna-dev to this issue.

[Genesis000001]

@Genesis000001 has applied to work on this issue as part of the Stellar Wave Program's 8th wave.

Hi maintainer, please assign this issue to me I promise to deliver a clean work

ℹ️ Repo Maintainers: To accept this application, review their application or assign @Genesis000001 to this issue.