FastAPI - OpenAPI

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

http://127.0.0.1:8000/docs

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

点击“试一下”按钮，然后点击随后出现的“执行”按钮。

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

FastAPI 使用OpenAPI规范生成模式。该规范确定如何定义API路径、路径参数等。OpenAPI标准定义的API模式决定了如何使用JSON模式发送数据。从您的浏览器访问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）。

在浏览器的地址栏中输入https://127.0.0.1:8000/redoc作为URL。