什么是Swagger UI
Swagger UI 是一个用于可视化和交互式地展示API文档的工具。它是Swagger(现称为OpenAPI)生态系统的一部分,旨在帮助开发者和API用户更好地理解、测试和调试API。
主要功能和作用
1. API文档自动生成:
Swagger UI可以从OpenAPI规范(以前称为Swagger规范)自动生成API文档。这使得API文档始终与实际实现保持同步,减少了手工编写和维护文档的工作量。
2. 交互式API测试:
Swagger UI提供了一个界面,用户可以在其中直接测试API端点。用户可以选择不同的HTTP方法(如GET、POST、PUT、DELETE),填写请求参数、头信息和请求体,然后发送请求并查看响应。
3. 可视化和易用性:
通过Swagger UI,API文档以一种结构化和用户友好的方式展示,帮助开发者和用户更直观地了解API的功能、参数和返回类型。
4. 支持多种授权机制:
Swagger UI支持多种API授权机制,如Basic Auth、Bearer Token、OAuth等,使用户能够在测试API时进行授权和认证。
5. 增强团队协作:
提供统一的API文档,帮助开发团队、测试团队和外部开发者更高效地合作,确保对API的理解和使用是一致的。
Authorization(apiKey)怎么获取?
我们在访问http://localhost:8000/swagger-ui.html进行接口调试的时候,会发现有些接口需要授权
点击Authorize,然后从网站请求中标头中获取Authorization填到以上界面中,就可以进行已授权的接口调试了: