FastAPI OpenAPI

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

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。A neatly formatted JSON response as follows will be displayed −

{
   "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。