Sync FastAPI endpoint routes with API reference documentation.
npx skills add https://github.com/jrmatherly/apollos-portal --skill api-doc-jrmatherly
Please help me install this Agent Skill. Skill: api-doc Source: https://github.com/jrmatherly/apollos-portal/tree/main/.claude/skills/api-doc Command: npx skills add https://github.com/jrmatherly/apollos-portal --skill api-doc-jrmatherly
Sync API reference documentation with the actual FastAPI routes to prevent drift between code and docs, saving time during refactors.
Run the API doc sync to align the docs with the latest backend routes.
High-intent search queries and answers about installing and using this skill.
To sync FastAPI documentation with endpoint routes, the tool scans backend/app/api/v1/endpoints decorators to extract routes and response models, then compares them against docs/api-reference/introduction.mdx to report and resolve discrepancies.
Preventing drift between FastAPI code and API reference docs requires comparing actual endpoint decorators against your MDX documentation files to identify missing or mismatched routes and automatically update reference pages.
The best way to update MDX API reference pages after refactoring endpoints is to analyze modified FastAPI route decorators, identify the changed API surface, and update endpoint tables and related docs to reflect current backend implementation.
You can automatically detect missing endpoints in FastAPI documentation by scanning route decorators in your endpoints directory and comparing the extracted API surface against your introduction.mdx file to flag undocumented routes.
Yes, this docs sync tool extracts response models directly from FastAPI decorators. It scans decorators like @router.get, @router.post, and @router.patch to capture paths and response models for documentation comparison.
shuremali02Generate FastAPI REST endpoints from API specifications with JWT authentication.
brainbrewlabsPublishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.
Vivekmano27Generate OpenAPI 3.0 documentation from NestJS and Django REST Framework codebases.
FaysilAlshareefEnrich OpenAPI specifications with summaries, descriptions, and examples.
