FastAPI - OpenAPI 规范

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

http://127.0.0.1:8000/docs

FastAPI 使用 Swagger UI 生成此文档。 浏览器会显示如下 −

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

可以看到内部执行的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) 提供的另一种自动文档化方法。

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