-
Notifications
You must be signed in to change notification settings - Fork 495
服务契约
Haotian Zhang edited this page Dec 16, 2024
·
4 revisions
服务契约基于开源的 springdoc-openapi
开发,实现 RestController 的扫描与上报,帮助开发者在北极星控制台查看 API 列表。
配置项Key | 默认值 | 是否必填 | 初始版本 | 配置项说明 |
---|---|---|---|---|
spring.cloud.polaris.contract.enabled | true | 否 | 2.0.0.0 | 是否开启服务契约扫描 |
spring.cloud.polaris.contract.basePackage | 否 | 2.0.0.0 | 服务契约扫描包路径,可以填多个,用“,”分隔。默认是主类所在的路径下,推荐将 ApplicationMainClass 写在外层 Package | |
spring.cloud.polaris.contract.basePath | /** | 否 | 2.0.0.0 | 服务契约扫描包含API路径,可以填多个,用“,”分隔。默认是“/**” |
spring.cloud.polaris.contract.excludePath | 否 | 2.0.0.0 | 服务契约扫描排除API路径,可以填多个,用“,”分隔 | |
spring.cloud.polaris.contract.group | polaris | 否 | 2.0.0.0 | 服务契约扫描Swagger分组名称 |
spring.cloud.polaris.contract.exposure | true | 否 | 2.0.0.0 | 是否开启 Swagger 相关暴露接口。如果设置为 false,则不暴露相关接口,以下路径将会屏蔽并返回403:/v2/api-docs、/v3/api-docs、/swagger-ui.html、/swagger-ui/index.html、/swagger-resource/、/webjars/springfox-swagger-ui/、/webjars/swagger-ui/ |
spring.cloud.polaris.contract.report.enabled | true | 否 | 2.0.0.0 | 是否开启服务契约上报 |
- 您在使用过程中遇到任何问题,请提 Issue 或者加入我们的开发者群告诉我们,我们会在第一时间反馈
- Spring Cloud Tencent 社区期待您的加入,一个 Star、PR 都是对我们最大的支持
- 项目介绍
- 使用指南
- 最佳实践
- 开发文档
- 学习资料