使用inspector功能查看和管理契约
【摘要】 本文介绍了CSE的inspector新特性的使用。
CSE从2.3.65版本（ServiceComb 1.2.0）开始，提供了inspector功能，该功能提供了用户查看、下载契约，生成文档和对API接口进行测试的功能。这个功能直接在微服务提供，用于弥补通过服务中心查看契约和对接口进行测试的不足。inspector功能后续会做进一步增强，除了管理契约，还可以观察微服务的内部状态，帮助定位一些常见问题。
· 启用inspector
在项目中启用inspector很简单，只需要在pom中增加如下依赖即可。
<dependency>
<groupId>org.apache.servicecomb</groupId>
<artifactId>inspector</artifactId>
</dependency>然后启动微服务即可。下面假设微服务监听的端口为8080。
· 使用inspector功能
inspector提供了管理界面，集成了swagger编辑器。输入 http://localhost:8080/inspector/index.html 后，出现如下界面。
注意：该功能被设计为辅助开发、设计、运维，第一次访问的时候加载很慢。
SWAGER编辑界面
在SWAGGER编辑界面，可以对接口进行测试。
HTML界面
HTML页面提供了更容易读写的格式，方便开发者查看接口说明。
输入 http://localhost:8080/inspector/schemas 可以查询所有的schema列表
["goodsRepositoryApi","goodsService","onlineMallApi","stockApi","goodsCategoryApi","goodsPriceApi"]输入 http://localhost:8080/inspector/download/schemas?format=HTML 可以下载文档。format支持HTML和SWAGGER两种格式。这个接口会下载所有契约文件，打包为zip格式。
输入 http://localhost:8080/inspector/schemas/goodsService?download=false&format=HTML 可以查看、下载单个契约文件。
【声明】本内容来自华为云开发者社区博主，不代表华为云及华为云开发者社区的观点和立场。转载时必须标注文章的来源（华为云社区）、文章链接、文章作者等基本信息，否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容，欢迎发送邮件进行举报，并提供相关证据，一经查实，本社区将立刻删除涉嫌侵权内容，举报邮箱：
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
作者其他文章
IoTA2019/10/25 07:18:211楼编辑删除举报