Skip to content

Commit 9db694e

Browse files
committed
docs: Add API documentation guidelines to CLAUDE.md
1 parent 26d8b01 commit 9db694e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,17 @@ This project uses a Makefile for all build and run operations. Always use these
2525
- **No Docker usage** without explicitly discussing it first
2626
- **Keep changes minimal** - avoid over-engineering or adding unnecessary features
2727

28+
## API Documentation
29+
30+
When adding, modifying, or removing API routes:
31+
- **Update the OpenAPI spec** at `internal/assets/openapi.json`
32+
- The API docs at `/api/docs` are auto-generated from the OpenAPI spec via Swagger UI
33+
- Include request/response schemas, parameters, and example values in the spec
34+
2835
## Project Structure
2936

3037
This is a Go application. Key directories:
3138
- `internal/` - Internal packages
3239
- `cmd/` - Entry points
40+
- `internal/assets/openapi.json` - OpenAPI specification (update when routes change)
3341
- `Makefile` - Build and lifecycle management

0 commit comments

Comments
 (0)