starter-api组件用于帮助开发者完成api接口的编写
- 规范统一的接口协议并定义统一的
POJO类 - 自动引入
swagger注解需要的相关jar包 - 提供
HTTP相关的常用常量和枚举类
- build.gradle.kts
implementation("com.tencent.devops:devops-boot-starter-api")- build.gradle
implementation 'com.tencent.devops:devops-boot-starter-api'项目的api-xxx模块包含了对外接口的声明以及数据格式的定义,最终作为二方包或者三方包提供给对外使用,因此需要开发者保持api模块的精简和规范,否则会引诸多问题,如:
- 不规范的依赖声明方式导致版本依赖冲突
- 引入过多&多余的依赖,导致模块臃肿
- 在
api模块中暴露敏感信息,如DO类
starter-api组件秉承这一原则,帮助开发者最大化精简和规范api模块的开发,但开发者仍然需要注意以下事项:
api模块慎重引入依赖,如需引入请使用implementation或comipleOnly方式- 对于
@RequestMapping、@FeignClient注解的依赖,使用comipleOnly的方式依赖compileOnly("org.springframework.cloud:spring-cloud-openfeign-core") api模块保持简洁,只包含和接口声明和数据格式的定义