Interactive Docs

noun

say it: “in-ter-AK-tiv DOKS” /ˌɪntərˈæktɪv ˈdɑks/

Web pages FastAPI makes by itself at /docs and /redoc that describe every endpoint and let you try each one from the browser.

What is Interactive Docs?

FastAPI builds interactive docs automatically at /docs (Swagger UI) and /redoc. You can try every endpoint right in the browser.

In a sentence

  • “Each new route shows up in the interactive docs by itself.”
  • “Kim opened the interactive docs at /docs and sent a test order without writing any client code.”

Level: Novice · More FastAPI terms at this level

Updated