Search⌘ K
AI Features

Interactive API Docs - Feature of FastAPI

Explore the automatic interactive API documentation features of FastAPI. Learn how to use Swagger UI and ReDoc to test API endpoints and understand route parameters and responses effectively.

Introduction to automatic UI documentation

One of the major benefits of FastAPI is that it is fully compatible with open standards for APIs, OpenAPI and JSON Schema. It provides an automatic UI generated for testing your entire API and its different routes. If you have previously used Postman, you will be able to see that the same thing is provided by FastAPI. Any API consumer can visit this UI to test all the routes and see what different parameters, header, body, etc. are required as well as the response from the API.

Try the API documentation provided by

...