Springboot整合Swagger2組件

IT那活兒發布于2023-01-11 13:20 / 3465人閱讀

現如今，前后端分離已經逐漸成為互聯網項目一種標準的開發方式，前端與后端交給不同的人員開發，但是項目開發中的溝通成本也隨之升高，這部分溝通成本主要在于前端開發人員與后端開發人員對WebAPI接口的溝通，Swagger2 就可以很好地解決，它可以動態生成Api接口文檔，降低溝通成本，促進項目高效開發。

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/");
   }
}

編寫測試 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 "登陸失敗,用戶名不存在或者密碼錯誤";
      }

  }
}

查看接口文檔

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

可直接支持在線調試接口

漢化

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

注意

我們在啟動后，請求http://ip:port/contextName/swagger-ui.html 直接報404錯誤；是因為Spring Boot默認是攔截靜態資源，導致找不到swagger-ui.html。

我們只要放開swagger的靜態資源即可。

END

更多精彩干貨分享

點擊下方名片關注

IT那活兒

GPU云服務器云服務器 springboot整合webrtc springboot整合mongodb SpringBoot springboot webRTC

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/129890.html

SpringBoot整合Swagger2，再也不用維護接口文檔了！

摘要：前后端分離后，維護接口文檔基本上是必不可少的工作。一個理想的狀態是設計好后，接口文檔發給前端和后端，大伙按照既定的規則各自開發，開發好了對接上了就可以上線了。本文主要和大伙來聊下在中如何整合。如此，就算配置成功了，非常方便。前后端分離后，維護接口文檔基本上是必不可少的工作。一個理想的狀態是設計好后，接口文檔發給前端和后端，大伙按照既定的規則各自開發，開發好了對接上了就可以上線了。當然...

ziwenxie 2019-08-16 16:05 評論0 收藏0
兩年了，我寫了這些干貨！

摘要：開公眾號差不多兩年了，有不少原創教程，當原創越來越多時，大家搜索起來就很不方便，因此做了一個索引幫助大家快速找到需要的文章系列處理登錄請求前后端分離一使用完美處理權限問題前后端分離二使用完美處理權限問題前后端分離三中密碼加鹽與中異常統一處理開公眾號差不多兩年了，有不少原創教程，當原創越來越多時，大家搜索起來就很不方便，因此做了一個索引幫助大家快速找到需要的文章！ Spring Boo...

huayeluoliuhen 2019-06-26 18:00 評論0 收藏0
ApiBoot - ApiBoot Swagger 使用文檔

摘要：相關配置配置參數參數介紹默認值是否啟用文檔標題快速集成文檔文檔描述通過自動化配置快速集成文檔，僅需一個注解一個依賴即可。注意通過所獲取的類型都為。 ApiBoot是一款基于SpringBoot1.x，2.x的接口服務集成基礎框架，內部提供了框架的封裝集成、使用擴展、自動化完成配置，讓接口開發者可以選著性完成開箱即用，不再為搭建接口框架而犯愁，從而極大...

yuanxin 2019-08-16 16:20 評論0 收藏0
Gradle環境下導出Swagger為PDF

摘要：沒錯，不支持，從導出的文檔也可以看到，部分中文無法顯示，目前我也尚未找到是否有配置可以實現這個功能。相對前面的方式，使用起來更加簡單，也可以修改配置輸出中文。更多精彩博文，歡迎訪問我的個人博客說明我個人是一直使用Swagger作為接口文檔的說明的。但是由于在一些情況下，接口文檔說明需要以文件的形式交付出去，如果再重新寫一份文檔難免有些麻煩。于是在網上看到了Swagger2Mar...

OnlyMyRailgun 2019-08-16 18:23 評論0 收藏0
《 Kotlin + Spring Boot ：下一代 Java 服務端開發》

摘要：下一代服務端開發下一代服務端開發第部門快速開始第章快速開始環境準備，，快速上手實現一個第章企業級服務開發從到語言的缺點發展歷程的缺點為什么是產生的背景解決了哪些問題為什么是的發展歷程容器的配置地獄是什么從到下一代企業級服務開發在移動開發領域《 Kotlin + Spring Boot ：下一代 Java 服務端開發》 Kotlin + Spring Boot ：下一代 Java...

springDevBird 2019-08-15 12:30 評論0 收藏0