Swagger介紹

Swagger 是一套用于設(shè)計(jì)、構(gòu)建、文檔化和測(cè)試 RESTful API 的開源工具集，它提供了一種標(biāo)準(zhǔn)化的方式來描述 API 的結(jié)構(gòu)、請(qǐng)求參數(shù)、響應(yīng)格式等信息，使得前后端開發(fā)人員能夠更高效地協(xié)作。

使用Swagger只需要按照它的規(guī)范去定義接口及接口相關(guān)信息，就可以做到生成接口文檔，以及在線調(diào)試頁面，官網(wǎng): https://swagger.io/ Knife4j 是為java MVC框架集成Swagger生成API文檔的增強(qiáng)解決方案。

主要使用過程

1、導(dǎo)入knife4j的maven坐標(biāo)：pom.xml 文件中導(dǎo)入坐標(biāo)

<dependency><groupId>com.github.xiaomin</groupId><artifactId>knife4j-spring-boot-start</artifactId><version>3.0.2</version>
</dependency>

2、在配置類中加入knife4j的相關(guān)配置

   @Bean
//    注解表示由Spring容器創(chuàng)建并管理public Docket docket() {//構(gòu)建生成接口文檔的一系列信息ApiInfo apiInfo = new ApiInfoBuilder().title("XXX").version("XX").description("XXX").build();Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).select()//指定生成接口需要掃描的包.apis(RequestHandlerSelectors.basePackage("com.sky.controller")).paths(PathSelectors.any()).build();return docket;}

3、設(shè)置靜態(tài)資源映射，否則接口文檔頁面無法訪問

  protected void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}

常用注解