Fastapi 简明教程

FastAPI - OpenAPI

在浏览器中输入以下 URL，以自动生成交互式文档。

http://127.0.0.1:8000/docs

FastAPI 使用 Swagger UI 来生成此文档。浏览器将显示以下内容：−

openapi

单击 'try it out' 按钮，然后单击随后出现的 'Execute' 按钮。

openapi1

您可以看到内部执行的 Curl 命令、请求 URL、响应头以及服务器响应的 JSON 格式。

FastAPI 使用 OpenAPI 规范生成模式。该规范确定如何定义 API 路径、路径参数等。由 OpenAPI 标准定义的 API 架构决定如何使用 JSON 架构发送数据。从浏览器访问 [role="bare"] [role="bare"]http://127.0.0.1:8000/openapi.json 。将以以下内容显示格式良好的 JSON 响应 −

{
   "openapi": "3.0.2",
   "info": {
      "title": "FastAPI",
      "version": "0.1.0"
   },
   "paths": {
      "/": {
         "get": {
            "summary": "Index",
            "operationId": "index__get",
            "responses": {
               "200": {
                  "description": "Successful Response",
                  "content": {
                     "application/json": {
                        "schema": {}
                     }
                  }
               }
            }
         }
      }
   }
}

FastAPI 还支持 Redoc ( https://github.com/Redocly/redoc )提供的另一种自动文档方法。

将 [role="bare"] [role="bare"]http://localhost:8000/redoc 输入浏览器地址栏作为 URL。

github