u
This commit is contained in:
@@ -27,9 +27,10 @@ Docs are generated from `@openapi` JSDoc on route handlers:
|
||||
|
||||
```bash
|
||||
npm run docs:api
|
||||
npm run api-graph # regenerate api-graph.svg + api-graph.dot
|
||||
```
|
||||
|
||||
That writes `docs/api/routes.md`, `docs/api/routes-all.md`, and per-route Markdown under `docs/api/routes/`. There is no generated `openapi.json` on disk — the interactive Swagger UI at `/docs/` builds the spec from the same `@openapi` JSDoc at runtime (`src/api/openapiSpec.js`).
|
||||
That writes `docs/api/routes.md`, `docs/api/routes-all.md`, and per-route Markdown under `docs/api/routes/`. `npm run api-graph` generates `api-graph.svg` and `api-graph.dot` visualizing the API resources, endpoints, and dataflow relationships. There is no generated `openapi.json` on disk — the interactive Swagger UI at `/docs/` builds the spec from the same `@openapi` JSDoc at runtime (`src/api/openapiSpec.js`).
|
||||
|
||||
### Function review files
|
||||
|
||||
|
||||
Reference in New Issue
Block a user