Add Swagger API docs page #50

Merged

erik merged 1 commit from feat/task-51eaa27f-swagger-api-docs into main

2026-05-22 10:34:14 -05:00

erik commented

2026-05-22 09:57:02 -05:00

Owner

Summary

Add @hono/swagger-ui to the template site.
Add GET /api/v1/docs serving Swagger UI.
Point Swagger UI at the existing OpenAPI source of truth: ./openapi.json.
Add route tests and document the docs URL.

Testing

make check
./scripts/pre-pr.sh
Manual smoke: run the template site on a temporary port and verify /api/v1/docs renders Swagger UI configured with ./openapi.json.

Task: #task-51eaa27f

## Summary - Add `@hono/swagger-ui` to the template site. - Add `GET /api/v1/docs` serving Swagger UI. - Point Swagger UI at the existing OpenAPI source of truth: `./openapi.json`. - Add route tests and document the docs URL. ## Testing - `make check` - `./scripts/pre-pr.sh` - Manual smoke: run the template site on a temporary port and verify `/api/v1/docs` renders Swagger UI configured with `./openapi.json`. Task: #task-51eaa27f

erik added 1 commit

2026-05-22 09:57:02 -05:00

feat: add Swagger API docs page

CI / build-lint-test (pull_request) Successful in 28s

Details

38f5d0fbd5

Task: #task-51eaa27f

erik commented

2026-05-22 10:00:03 -05:00

Author

Owner

PR Review: Approved

Summary

Reviewed PR #50 at commit 38f5d0f. The PR adds the requested Swagger UI vertical slice: GET /api/v1/docs is registered under the existing API v1 surface, uses @hono/swagger-ui, points at the existing OpenAPI source of truth via ./openapi.json, includes route tests, and documents the new API docs URL.

Acceptance Criteria

GET /api/v1/docs returns HTTP 200 HTML.
The docs HTML contains Swagger UI assets/initialization.
The docs page points at ./openapi.json.
Existing GET /api/v1/openapi.json remains available and parseable.
Tests cover the docs route.
README or template docs mention the API docs URL.
Relevant lint/test checks pass: make check, ./scripts/pre-pr.sh, manual Swagger UI smoke, and Forgejo CI all passed.

Blocking Issues

None.

Warnings

None.

Verdict

Approved for merge.

## PR Review: Approved ### Summary Reviewed PR #50 at commit `38f5d0f`. The PR adds the requested Swagger UI vertical slice: `GET /api/v1/docs` is registered under the existing API v1 surface, uses `@hono/swagger-ui`, points at the existing OpenAPI source of truth via `./openapi.json`, includes route tests, and documents the new API docs URL. ### Acceptance Criteria - [x] `GET /api/v1/docs` returns HTTP 200 HTML. - [x] The docs HTML contains Swagger UI assets/initialization. - [x] The docs page points at `./openapi.json`. - [x] Existing `GET /api/v1/openapi.json` remains available and parseable. - [x] Tests cover the docs route. - [x] README or template docs mention the API docs URL. - [x] Relevant lint/test checks pass: `make check`, `./scripts/pre-pr.sh`, manual Swagger UI smoke, and Forgejo CI all passed. ### Blocking Issues None. ### Warnings None. ### Verdict Approved for merge.

erik referenced this pull request

2026-05-22 10:02:55 -05:00

Add Swagger API docs page #49

erik merged commit cd1c40f75f into main

2026-05-22 10:34:14 -05:00

erik referenced this pull request from a commit

2026-05-22 10:34:14 -05:00

Merge pull request 'Add Swagger API docs page' (#50) from feat/task-51eaa27f-swagger-api-docs into main

erik referenced this pull request

2026-05-22 10:39:42 -05:00

Add Swagger API docs page #49