最新国产好看的视频,伊人天堂AV在线,国产Aaaaaa视频,蜜臀视频在线观看一区,人妻av色图,密臀久久久精品影片,青青视频免费观看毛片,久草在线观看视,国产三级精品色情在线

Springboot中集成Swagger2框架的方法

 更新時(shí)間:2017年12月12日 11:51:51   投稿:mrr  
這篇文章主要介紹了Springboot中集成Swagger2框架的方法,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下

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

既然接口文檔需要花費(fèi)精力去維護(hù),還要適當(dāng)?shù)倪M(jìn)行面對面交流溝通,我們何不想一個(gè)辦法,第一:可以不用寫接口文檔;第二:前端與后端溝通接口問題的時(shí)候,后端是否可以提供一個(gè)URL,在這個(gè)URL中羅列出所有可以調(diào)用的服務(wù)接口,并在每個(gè)服務(wù)接口中羅列出參數(shù)的說明,返回值的說明,第三:后端接口如果能模擬調(diào)用就所有問題都解決了。本文我們重點(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)類,代碼如下:

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

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

@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)文章請關(guān)注分享牛的博客")
        .termsOfServiceUrl("http://www.shareniu.com/")
        .contact("牛牛")
        .license("Copyright 2017-2018 分享牛")
        .version("1.0")
        .build();
  }
}

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

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

1.2. 新增文檔說明

上述的類聲明之后,我們其實(shí)就可以直接調(diào)用了,但是為了增加文檔的可讀性,我們還是需要在接口中增加一些說明,我們先寫一個(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對象創(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來獲取用戶詳細(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來指定更新對象")
  @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來指定刪除對象")
  @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:用來描述該接口的作用??梢酝ㄟ^該注解說明接口的職責(zé)、返回頭信息、方法的請求方式("GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH")、協(xié)議( http, https, ws, wss)、http狀態(tài)碼。
@ApiImplicitParam:用來給參數(shù)增加說明。可以設(shè)置參數(shù)的名稱、是否是必填項(xiàng)、參數(shù)的描述信息、是否只讀等。

上述代碼提交之后,啟動(dòng)springboot,訪問http://127.0.0.1:8080/swagger-ui.html,如下圖所示: 

上圖分為兩個(gè)部分,上部分是通過Swagger2類配置出來的,下半部分是UserController類中的接口文檔。
這里我們以/user為例進(jìn)行說明:

點(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)成功返回了。

總結(jié)

以上所述是小編給大家介紹的Springboot中集成Swagger2框架的方法,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持!

相關(guān)文章

  • Java中Array、List、ArrayList的區(qū)別及說明

    Java中Array、List、ArrayList的區(qū)別及說明

    這篇文章主要介紹了Java中Array、List、ArrayList的區(qū)別及說明,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2023-07-07
  • 詳解spring cloud config整合gitlab搭建分布式的配置中心

    詳解spring cloud config整合gitlab搭建分布式的配置中心

    這篇文章主要介紹了詳解spring cloud config整合gitlab搭建分布式的配置中心,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2018-01-01
  • SpringBoot整合JPA詳細(xì)代碼實(shí)例

    SpringBoot整合JPA詳細(xì)代碼實(shí)例

    這篇文章主要給大家介紹了關(guān)于SpringBoot整合JPA的相關(guān)資料,JPA(Java Persistence API)是Sun官方提出的Java持久化規(guī)范,它為Java開發(fā)人員提供了一種對象/關(guān)聯(lián)映射工具來管理Java應(yīng)用中的關(guān)系數(shù)據(jù),需要的朋友可以參考下
    2024-05-05
  • Spring加載加密的配置文件詳解

    Spring加載加密的配置文件詳解

    這篇文章主要為大家詳細(xì)介紹了Spring加載加密的配置文件,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2017-07-07
  • java實(shí)現(xiàn)桌球小游戲

    java實(shí)現(xiàn)桌球小游戲

    這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)桌球小游戲,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2019-07-07
  • SpringCloud容器化服務(wù)發(fā)現(xiàn)及注冊實(shí)現(xiàn)方法解析

    SpringCloud容器化服務(wù)發(fā)現(xiàn)及注冊實(shí)現(xiàn)方法解析

    這篇文章主要介紹了SpringCloud容器化服務(wù)發(fā)現(xiàn)及注冊實(shí)現(xiàn)方法解析,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2020-08-08
  • Spring mvc 實(shí)現(xiàn)用戶登錄的方法(攔截器)

    Spring mvc 實(shí)現(xiàn)用戶登錄的方法(攔截器)

    這篇文章主要介紹了Spring mvc 實(shí)現(xiàn)用戶登錄的方法(攔截器),小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2018-07-07
  • IDEA插件之彩虹括號(hào)Rainbow?Brackets使用介紹

    IDEA插件之彩虹括號(hào)Rainbow?Brackets使用介紹

    這篇文章主要為大家介紹了IDEA插件之彩虹括號(hào)Rainbow?Brackets使用介紹,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪
    2023-03-03
  • java中JSON字符串轉(zhuǎn)換為Map集合的兩種方法

    java中JSON字符串轉(zhuǎn)換為Map集合的兩種方法

    本文主要介紹了java中JSON字符串轉(zhuǎn)換為Map集合,包含了兩種方法,這種需求可能涉及到從外部接口獲取數(shù)據(jù),或者在程序中處理配置信息等,感興趣的可以了解一下
    2024-07-07
  • mybatis報(bào)Query?was?Empty異常的問題

    mybatis報(bào)Query?was?Empty異常的問題

    這篇文章主要介紹了mybatis報(bào)Query?was?Empty異常的問題,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2022-03-03

最新評論

宁都县| 河曲县| 运城市| 新密市| 绥芬河市| 平遥县| 孟州市| 九江县| 文山县| 汤阴县| 扶余县| 广昌县| 绥滨县| 广西| 凤台县| 安阳县| 历史| 蒲江县| 沙洋县| 达拉特旗| 神木县| 修文县| 宁国市| 磐石市| 平塘县| 同江市| 洞口县| 贡觉县| 股票| 洪雅县| 启东市| 个旧市| 司法| 洛扎县| 乌什县| 阿巴嘎旗| 龙里县| 临泉县| 美姑县| 曲水县| 翼城县|