Feature: Add OpenAPI Specification and Swagger UI Documentation #19

New issue

Closed

opened 2026-07-04 21:50:04 +00:00 by psycodepath · 0 comments

psycodepath commented

2026-07-04 21:50:04 +00:00

Owner

Motivation

To make the REST API discoverable, testable, and easy to integrate, we need standard OpenAPI >= 3.0 specification documentation and a built-in Swagger UI renderer.

Description

Create an OpenAPI yaml/json spec file describing all /api/v1 routes and add an action to render the Swagger UI web page under /api.

User Story

As an API developer or external consumer, I want to view a interactive Swagger UI page at /api so that I can explore and test the endpoints easily.

Gherkin Feature

Feature: OpenAPI and Swagger UI
  As a user
  I want to visit /api
  So that I can see the Swagger UI documentation

Acceptance Criteria

Create openapi.json or openapi.yaml describing Tasks, Grocery, and Meals REST API endpoints.
Add a Web Action class in the Kernel to render a Swagger UI HTML page at /api loading the spec.
Ensure all resources and routing are Level 8 clean and pass all checks.

### Motivation To make the REST API discoverable, testable, and easy to integrate, we need standard OpenAPI >= 3.0 specification documentation and a built-in Swagger UI renderer. ### Description Create an OpenAPI yaml/json spec file describing all `/api/v1` routes and add an action to render the Swagger UI web page under `/api`. ### User Story As an API developer or external consumer, I want to view a interactive Swagger UI page at `/api` so that I can explore and test the endpoints easily. ### Gherkin Feature ```gherkin Feature: OpenAPI and Swagger UI As a user I want to visit /api So that I can see the Swagger UI documentation ``` ### Acceptance Criteria - [ ] Create `openapi.json` or `openapi.yaml` describing Tasks, Grocery, and Meals REST API endpoints. - [ ] Add a Web Action class in the Kernel to render a Swagger UI HTML page at `/api` loading the spec. - [ ] Ensure all resources and routing are Level 8 clean and pass all checks.

psycodepath added this to the v1.4.0-rest-api milestone

2026-07-04 21:50:04 +00:00

psycodepath self-assigned this

2026-07-04 21:50:04 +00:00

psycodepath referenced this issue from a pull request that will close it,

2026-07-04 21:51:09 +00:00

feat(api): add OpenAPI spec and Swagger UI documentation at /api #20

psycodepath closed this issue

2026-07-05 19:29:04 +00:00

psycodepath referenced this issue from a commit

2026-07-05 19:29:05 +00:00

feat(api): add OpenAPI spec and Swagger UI documentation at /api (#20)