Swagger UI

Swagger UI是FastAPI内置集成的交互式文档页面，可以查看FastAPI应用所有的路径操作——有哪些路径、什么HTTP方法、收什么参数、返回什么结构，还能直接在页面上发请求测试，功能上类似 Postman、Insomnia 这类 API 测试工具的轻量版。

以这个简单图书项目为例，打开链接http://127.0.0.1:8000/docs就进入了Swagger UI页面。

图中显示了项目有一个路径操作，请求方法是GET，请求路径是/books。此外还有其它信息：

• default 表示标签（tag），文档页给路径操作分组的名字，在装饰器的参数中添加tags=['图书']即可把分组名字换成“图书”，省略tags参数时，标签默认为default。
  
• Get All Books表示摘要（summary），是对这个路径操作（API）的一个总结，省略summary参数时FastAPI会根据函数名自动生成摘要，例如处理函数名为get_all_books，自动生成的摘要为Get All Books。
  

拉开该路径操作，点击“Try it out”。

再点击“Execute”，页面会向服务器发送一个真实的GET请求，并显示响应状态码和内容——相当于在文档页上直接完成了API测试。

点击“Cancel”则退出本次调试状态，页面退出参数填写模式、回到只读的文档视图(返回文档展示模式，不发请求）。

点击“Execute”之后即可查看服务器返回的响应内容。

看完后如果想再次发送重新测试，可以点击“Clear”先清空响应内容，清空后再点击“Execute”。