Springboot整合Swagger2組件

IT那活兒發(fā)布于2023-01-11 13:20 / 3473人閱讀

現(xiàn)如今，前后端分離已經(jīng)逐漸成為互聯(lián)網(wǎng)項(xiàng)目一種標(biāo)準(zhǔn)的開發(fā)方式，前端與后端交給不同的人員開發(fā)，但是項(xiàng)目開發(fā)中的溝通成本也隨之升高，這部分溝通成本主要在于前端開發(fā)人員與后端開發(fā)人員對(duì)WebAPI接口的溝通，Swagger2 就可以很好地解決，它可以動(dòng)態(tài)生成Api接口文檔，降低溝通成本，促進(jìn)項(xiàng)目高效開發(fā)。

Swagger2組件配置

pom.xml添加依賴


       <dependency>
           <groupId>io.springfoxgroupId>
           <artifactId>springfox-swagger2artifactId>
           <version>2.4.0version>
       dependency>
       <dependency>
           <groupId>io.springfoxgroupId>
           <artifactId>springfox-swagger-uiartifactId>
           <version>2.4.0version>
       dependency>

Swagger2配置類

@Configuration
@EnableSwagger2
public class Swagger2Config implements WebMvcConfigurer {

   @Bean
   public Docket createRestApi() {
       return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
           .apis(RequestHandlerSelectors.basePackage("task.web")).paths(PathSelectors.any()).build();
   }

   private ApiInfo apiInfo() {
       return new ApiInfoBuilder().title("Simple APIs").description("simple apis")
           .termsOfServiceUrl("http://www.***").contact(new Contact("d***", "http://***", "***@shsnc.com"))
           .version("1.0").build();
   }

   @Override
   public void addResourceHandlers(ResourceHandlerRegistry registry) {
       registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
       registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
   }
}

編寫測(cè)試 Controller

@Controller
@RequestMapping("/test")
@Api(tags = "用戶接口")
public class TestController {

   @GetMapping("/login")
   @ApiImplicitParams({@ApiImplicitParam(name = "username", value = "用戶名", paramType = "query"),
       @ApiImplicitParam(name = "password", value = "密碼", paramType = "query")})
   @ResponseBody
   @ApiOperation(value = "用戶登陸接口")
   public String login(@RequestParam("username") String username, @RequestParam("password") String password) {
       if ("shsnc".equals(username) && "123456".equals(password)) {
           return "登陸成功";
      } else {
           return "登陸失敗,用戶名不存在或者密碼錯(cuò)誤";
      }

  }
}

查看接口文檔

啟動(dòng)我們的web工程，訪問地址http://ip:port/contextName/swagger-ui.html，就可以看到文檔頁面了。

可直接支持在線調(diào)試接口

漢化

在resources目錄下創(chuàng)建文件夾META-INF.resources
將springfox-swagger-ui.jar包中swagger-ui.html拷貝到新建META-INF.resources里。
swagger-ui.html中導(dǎo)入國(guó)際化中文版js
重啟項(xiàng)目，清空緩存，刷新頁面。

注意

我們?cè)趩?dòng)后，請(qǐng)求http://ip:port/contextName/swagger-ui.html 直接報(bào)404錯(cuò)誤；是因?yàn)镾pring Boot默認(rèn)是攔截靜態(tài)資源，導(dǎo)致找不到swagger-ui.html。

我們只要放開swagger的靜態(tài)資源即可。