Springboot中怎么集成Swagger2框架-創(chuàng)新互聯(lián)

本篇內(nèi)容主要講解“Springboot中怎么集成Swagger2框架”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“Springboot中怎么集成Swagger2框架”吧!

創(chuàng)新互聯(lián)是一家專(zhuān)注于成都網(wǎng)站設(shè)計(jì)、網(wǎng)站制作與策劃設(shè)計(jì),蓮花網(wǎng)站建設(shè)哪家好?創(chuàng)新互聯(lián)做網(wǎng)站,專(zhuān)注于網(wǎng)站建設(shè)10年,網(wǎng)設(shè)計(jì)領(lǐng)域的專(zhuān)業(yè)建站公司;建站業(yè)務(wù)涵蓋:蓮花等地區(qū)。蓮花做網(wǎng)站價(jià)格咨詢:18980820575

摘要：在項(xiàng)目開(kāi)發(fā)中，往往期望做到前后端分離，也就是后端開(kāi)發(fā)人員往往需要輸出大量的服務(wù)接口，接口的提供方無(wú)論是是Java還是PHP等語(yǔ)言，往往會(huì)要花費(fèi)一定的精力去寫(xiě)接口文檔，比如A接口的地址、需要傳遞參數(shù)情況、返回值的JSON數(shù)據(jù)格式以及每一個(gè)字段說(shuō)明、當(dāng)然還要考慮HTTP請(qǐng)求頭、請(qǐng)求內(nèi)容等信息。隨著項(xiàng)目的進(jìn)度快速高速的迭代，后端輸出的接口往往會(huì)面臨修改、修復(fù)等問(wèn)題，那也意味著接口文檔也要進(jìn)行相應(yīng)的調(diào)整。接口文檔的維護(hù)度以及可讀性就大大下降。

既然接口文檔需要花費(fèi)精力去維護(hù)，還要適當(dāng)?shù)倪M(jìn)行面對(duì)面交流溝通，我們何不想一個(gè)辦法，第一：可以不用寫(xiě)接口文檔；第二：前端與后端溝通接口問(wèn)題的時(shí)候，后端是否可以提供一個(gè)URL，在這個(gè)URL中羅列出所有可以調(diào)用的服務(wù)接口，并在每個(gè)服務(wù)接口中羅列出參數(shù)的說(shuō)明，返回值的說(shuō)明，第三：后端接口如果能模擬調(diào)用就所有問(wèn)題都解決了。本文我們重點(diǎn)講解一下Sringboot中集成Swagger2框架。

1.1. 添加Swagger2依賴

在項(xiàng)目的pom.xml文件中增加如下的依賴。

<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger2</artifactId>
 <version>2.7.0</version>
</dependency>
<dependency>
 <groupId>io.springfox</groupId>
 <artifactId>springfox-swagger-ui</artifactId>
 <version>2.7.0</version>
</dependency>

首先，我們需要建立一個(gè)啟動(dòng)類(lèi)，代碼如下：

@SpringBootApplication
public class Application {
 public static void main(String[] args) {
 SpringApplication.run(Application.class, args);
 }
}

然后在上述類(lèi)的同級(jí)目錄中新建swagger2的配置類(lèi)如下所示：

@Configuration
@EnableSwagger2
public class Swagger2 {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.basePackage("com.shareniu.web"))
        .paths(PathSelectors.any())
        .build();
  }
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("跟著分享牛學(xué)習(xí)Springboot源碼分析系列課程")
        .description("更多Spring Boot相關(guān)文章請(qǐng)關(guān)注分享牛的博客")
        .termsOfServiceUrl("http://www.shareniu.com/")
        .contact("牛牛")
        .license("Copyright 2017-2018 分享牛")
        .version("1.0")
        .build();
  }
}

@Configuration制定了spring要加載這個(gè)類(lèi)，@EnableSwagger2注解要開(kāi)啟Swagger功能。

上述中的ApiInfo最終都會(huì)展現(xiàn)在前端，我們使用了掃描包的方式配置配置，也就是RequestHandlerSelectors.basePackage。在這個(gè)包以及子包中的控制器最終都是生成API文檔。（除了被@ApiIgnore注解指定的請(qǐng)求）。

1.2. 新增文檔說(shuō)明

上述的類(lèi)聲明之后，我們其實(shí)就可以直接調(diào)用了，但是為了增加文檔的可讀性，我們還是需要在接口中增加一些說(shuō)明，我們先寫(xiě)一個(gè)控制器如下所示：

@RestController
@RequestMapping(value="/users")
public class UserController {
  static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>());
  static {
   User user = new User();
   user.setAge(18);
   user.setId(1L);
   user.setName("aa");
   users.put(1L, user);
  }
  @ApiOperation(value="獲取所有用戶列表", notes="")
  @RequestMapping(value={""}, method=RequestMethod.GET)
  public List<User> getUserList() {
    List<User> r = new ArrayList<User>(users.values());
    return r;
  }
  @ApiOperation(value="創(chuàng)建新的用戶", notes="根據(jù)User對(duì)象創(chuàng)建用戶")
  @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "User")
  @RequestMapping(value="", method=RequestMethod.POST)
  public String postUser(@RequestBody User user) {
    users.put(user.getId(), user);
    return "success";
  }
  @ApiOperation(value="獲取用戶詳細(xì)信息", notes="根據(jù)url的id來(lái)獲取用戶詳細(xì)信息")
  @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
  @RequestMapping(value="/{id}", method=RequestMethod.GET)
  public User getUser(@PathVariable Long id) {
    return users.get(id);
  }
  @ApiOperation(value="更新用戶詳細(xì)信息", notes="根據(jù)url的id來(lái)指定更新對(duì)象")
  @ApiImplicitParams({
      @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long"),
      @ApiImplicitParam(name = "user", value = "用戶詳細(xì)實(shí)體user", required = true, dataType = "User")
  })
  @RequestMapping(value="/{id}", method=RequestMethod.PUT)
  public String putUser(@PathVariable Long id, @RequestBody User user) {
    User u = users.get(id);
    u.setName(user.getName());
    u.setAge(user.getAge());
    users.put(id, u);
    return "success";
  }
  @ApiOperation(value="刪除已存在的用戶", notes="根據(jù)url的id來(lái)指定刪除對(duì)象")
  @ApiImplicitParam(name = "id", value = "用戶ID", required = true, dataType = "Long")
  @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
  public String deleteUser(@PathVariable Long id) {
    users.remove(id);
    return "success";
  }
}

 @ApiOperation：用來(lái)描述該接口的作用?？梢酝ㄟ^(guò)該注解說(shuō)明接口的職責(zé)、返回頭信息、方法的請(qǐng)求方式（"GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH"）、協(xié)議（ http, https, ws, wss）、http狀態(tài)碼。
@ApiImplicitParam：用來(lái)給參數(shù)增加說(shuō)明?？梢栽O(shè)置參數(shù)的名稱(chēng)、是否是必填項(xiàng)、參數(shù)的描述信息、是否只讀等。

上述代碼提交之后，啟動(dòng)springboot，訪問(wèn)http://127.0.0.1:8080/swagger-ui.html

為兩個(gè)部分，上部分是通過(guò)Swagger2類(lèi)配置出來(lái)的，下半部分是UserController類(lèi)中的接口文檔。
這里我們以/user為例進(jìn)行說(shuō)明：

點(diǎn)擊/user如下圖所示：

上圖黃色的地方表示，該接口返回的樣例數(shù)據(jù)。也就是User的數(shù)據(jù)結(jié)構(gòu)。Response Content Type：接口返回的頭信息。點(diǎn)擊Try it out。如下所示：

該接口返回的baody、code碼、響應(yīng)頭已經(jīng)成功返回了。

到此，相信大家對(duì)“Springboot中怎么集成Swagger2框架”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是創(chuàng)新互聯(lián)建站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！

網(wǎng)站標(biāo)題：Springboot中怎么集成Swagger2框架-創(chuàng)新互聯(lián)
本文來(lái)源：http://www.muchs.cn/article34/dhjepe.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供用戶體驗(yàn)、App設(shè)計(jì)、網(wǎng)站建設(shè)、網(wǎng)站設(shè)計(jì)、小程序開(kāi)發(fā)、品牌網(wǎng)站設(shè)計(jì)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)