Fastapi: [FEATURE] Export API docs

[jaddison]

Is it possible to have a method to extract or export the auto generated docs to a static set of pages? (This may already be possible, and I've missed it)

Thinking of separate docs subdomain and separating API and docs HTTP request traffic, etc.

[petervanderdoes]

It's a matter of copying the openapi.json and setting up which ever Doc System you wanna use, Swagger, Redoc. They both are just static one page websites.

[jaddison]

Is it that easy? That's pretty cool. Thanks - closing this issue.

[dmontagu]

@jaddison This section of the docs may also be of interest to you: https://fastapi.tiangolo.com/tutorial/extending-openapi/#self-hosting-javascript-and-css-for-docs

[pawamoy]

Page was moved to https://fastapi.tiangolo.com/advanced/extending-openapi/#self-hosting-javascript-and-css-for-docs

It's a matter of copying the openapi.json and setting up which ever Doc System you wanna use, Swagger, Redoc. They both are just static one page websites.

Then, is there a way to generate and export the openapi.json, without having to actually run/serve the API? I would like to generate the JSON file in a CI job, keep it as an artifact, and deploy it somewhere else in another job. If I have to run the API to get the JSON file, it means I have to run the API in a background process and wget/curl the /openapi.json URL in a foreground process? It feels a bit weird to use background processes in CI.

[nsidnev]

@pawamoy
You can call FastAPI.openapi() method that will return OpenAPI schema as python dictionary. Check here for more information.

[tiangolo]

Thanks for the help here everyone! :cake: :bowing_man:

And thanks @jaddison for reporting back and closing the issue :+1:

[pawamoy]

I posted a Python script here to export the ReDoc docs into a standalone HTML file, if anyone is interested :wink: