什么是Swagger UI?
Swagger UI是一个开源工具,它允许任何人——从您的开发团队到您的最终消费者——可视化API的资源并与之交互,而无需任何实现逻辑。它是从您的OpenAPI(以前称为Swagger)规范自动生成的,通过可视化文档,它使后端实现和客户端消费变得容易。
主要特点
- 交互式文档: 允许用户直接在浏览器中测试API调用,从而轻松探索和理解API功能。
- OAS支持: 完全支持OpenAPI规范3.0和2.0,使其与庞大的工具生态系统兼容。
- 易于设置: 可以通过Docker、公共CDN运行,或直接集成到您的Web应用程序中。
- 可定制: UI的外观和感觉可以完全定制,以匹配您的品牌标识。
- 无需实现: 从静态OpenAPI定义文件生成文档,允许采用设计优先的API开发方法。
使用案例
- 公共API文档: 为使用您公共API的外部开发人员提供美观、交互式的文档。
- 内部API中心: 作为所有内部微服务和API的中央真实来源,改善开发人员的入职和协作。
- API测试与调试: 使用各种参数快速向API端点发送请求,以测试响应和调试问题。
- 客户端SDK生成: Swagger UI使用的OpenAPI规范可用于生成数十种语言的客户端库。
入门指南
开始使用Swagger UI的最快方法是使用Docker。此命令将在端口80上启动一个Web服务器,并显示经典的Petstore API示例。
```bash docker run -p 80:8080 -e URL=https://petstore.swagger.io/v2/swagger.json swaggerapi/swagger-ui
运行此命令后,打开浏览器并导航到http://localhost/。您将看到Petstore API的交互式API文档。然后,您可以将URL环境变量替换为您自己的OpenAPI规范文件的链接。
定价
Swagger UI是一个完全免费的开源工具,根据Apache 2.0许可证分发。