Skip to content

Serving the AsyncAPI Documentation#

FastStream provides a command to serve the AsyncAPI documentation.

Note

This feature requires an Internet connection to obtain the AsyncAPI HTML via CDN.

faststream docs serve basic:app

In the above command, we are providing the path in the format of python_module:FastStream. Alternatively, you can also specify asyncapi.json or asyncapi.yaml to serve the AsyncAPI documentation.

faststream docs serve asyncapi.json
# or
faststream docs serve asyncapi.yaml

After running the command, it should serve the AsyncAPI documentation on port 8000 and display the following logs in the terminal.

INFO:     Started server process [2364992]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://localhost:8000 (Press CTRL+C to quit)

And you should be able to see the following page in your browser:

HTML-page

HTML-page

Tip

The command also offers options to serve the documentation on a different host and port.

Last update: 2023-09-22