微服务项目引入knife4j--接口文档（swagger2）

DreamCatcher-qin

已于 2022-03-06 21:36:56 修改

阅读量1.7k

点赞数 3

分类专栏：微服务文章标签：微服务 java spring boot spring cloud

于 2022-03-06 21:27:34 首次发布

本文链接：https://blog.csdn.net/shinexunmeng/article/details/123317605

版权

使用组件： knife4j，前身是swagger-bootstrap-ui,前身swagger-bootstrap-ui是一个纯swagger-ui的ui皮肤项目

使用方式：引入依赖，可以已纳入最新版本，然后配置类swagger

<dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <version>${knife4j.starter.version}</version>
</dependency>

具体可以参考： http://t.csdn.cn/stFG2

一、第一步：网关模块配置

1.1 pom文件啊引入依赖

<!--knife4j接口-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <version>${knife4j.starter.version}</version>
</dependency>

版本： 
<knife4j.starter.version>3.0.3</knife4j.starter.version>

2.2 gateway模块配置

类RouteProperties 路由来源，获取配置文件的服务路由名称

/**
 * 路由配置
 *
 */
@Component
@Data
@RefreshScope
@ConfigurationProperties("project.document")
public class RouteProperties {

   private final List<RouteResource> resources = new ArrayList<>();

}

获取配置中路由的属性值

@Data
public class RouteResource {

   /**
    * 文档名
    */
   private String name;

   /**
    * 文档所在服务地址
    */
   private String location;

   /**
    * 文档版本
    */
   private String version;

}

对应的bootstrap.yml 配置文件, 注意对齐格式，否则会报错