最后更新:
Click to expand / collapse
为了使开发人员方便,API必须易于理解,可测试且有据可查。我们连接和配置Swagger UI、Postman和Insomnia-三种最受欢迎的工具,可让您快速测试API,了解查询结构,并简化内部团队和外部合作伙伴的集成过程。
为什么需要这些工具
| 工具 | 指定 |
|---|---|
| Swagger UI | BOM OpenAPI在线文档的自动生成 |
| Postman | 手动和自动测试查询、集合、脚本 |
| Insomnia | 方便调试,处理交流、令牌、GraphQL、REST和gRPC |
我们实现的机会
从代码生成OpenAPI (Swagger)规格
在浏览器中直接进行交互式API测试(Swagger UI)
在Postman/Insomnia中导入收藏品,其中包含所有endpoint的示例
与OAuth2、JWT、API密钥一起使用工具
将测试和文档与CI/CD pipline同步
为外部合作伙伴发布馆藏
对团队和客户的好处
快速登陆新开发人员
加快外部团队的集成
基于API结构的单一真相来源
在任何阶段简化测试和调试
减少合作伙伴提出的问题和集成错误
在哪里,特别重要
开源API或SDK平台
内部微服务,经常更改
API第一产品和B2B服务
任何具有高开发速度和团队变更的项目