Skip to content
Seed & Source Docs

API Auto-Generation

Use the built-in scripts to generate reference pages from live OpenAPI payloads.

Python API

Terminal window
PYTHON_API_OPENAPI_URL=http://localhost:8000/openapi.json ./bin/generate_python_api_docs.sh

Output default:

  • src/content/docs/reference/python-api.md

Rails API

Terminal window
RAILS_API_OPENAPI_URL=http://localhost:3000/api-docs/v1/openapi.json ./bin/generate_rails_api_docs.sh

Output default:

  • src/content/docs/reference/rails-api.md

Notes

  • Both scripts are idempotent and overwrite only their target output file.
  • If your API exposes OpenAPI at another path, set PYTHON_API_OPENAPI_URL or RAILS_API_OPENAPI_URL.
  • Commit generated pages when they represent released API contracts.