Skip to content
D
Documentation

FastAPIDetector

reference
1 min readUpdated

Kind: Class

Source: atloria-monorepo/packages/doc-automation/src/v2/stages/stage-01-parse/detectors/fastapi-detector.ts

FastAPI Detector

Methods

MethodSignatureReturns
detectRoutesdetectRoutes(entities: Entity[])DetectedFastAPIRoute[]
detectModelsdetectModels(entities: Entity[])DetectedPydanticModel[]
getRouteSummarygetRouteSummary(route: DetectedFastAPIRoute)string

Where it refuses work

  • FastAPIDetector stops the work with an early return when modelMatch && /^[A-Z]/.test(modelMatch[1]).
  • FastAPIDetector stops the work with an early return when !tagsMatch.
  • FastAPIDetector stops the work with an early return when !classMatch.
  • FastAPIDetector stops the work with an early return when !defaultValue.

Was this page helpful?

Download as PDF
ADocs generated by Atloria — from the code, always in sync →