欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

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請(qǐng)求頭、請(qǐng)求內(nèi)容等信息。隨著項(xiàng)目的進(jìn)度快速高速的迭代,后端輸出的接口往往會(huì)面臨修改、修復(fù)等問題,那也意味著接口文檔也要進(jìn)行相應(yīng)的調(diào)整。接口文檔的維護(hù)度以及可讀性就大大下降。

既然接口文檔需要花費(fèi)精力去維護(hù),還要適當(dāng)?shù)倪M(jìn)行面對(duì)面交流溝通,我們何不想一個(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)文章請(qǐng)關(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注解指定的請(qǐng)求)。

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對(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來獲取用戶詳細(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來指定更新對(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來指定刪除對(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:用來描述該接口的作用??梢酝ㄟ^該注解說明接口的職責(zé)、返回頭信息、方法的請(qǐng)求方式("GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS" and "PATCH")、協(xié)議( http, https, ws, wss)、http狀態(tài)碼。
@ApiImplicitParam:用來給參數(shù)增加說明??梢栽O(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框架的方法,希望對(duì)大家有所幫助,如果大家有任何疑問請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!

相關(guān)文章

  • 菜鳥學(xué)習(xí)java設(shè)計(jì)模式之單例模式

    菜鳥學(xué)習(xí)java設(shè)計(jì)模式之單例模式

    這篇文章主要為大家詳細(xì)介紹了java設(shè)計(jì)模式之單例模式的相關(guān)資料,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2017-11-11
  • SpringBoot 集成 activiti的示例代碼

    SpringBoot 集成 activiti的示例代碼

    這篇文章主要介紹了SpringBoot 集成 activiti的示例代碼,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下
    2020-10-10
  • AspectJ的基本用法

    AspectJ的基本用法

    本文主要介紹了AspectJ的基本用法。具有很好的參考價(jià)值。下面跟著小編一起來看下吧
    2017-04-04
  • 如何使用HttpClient發(fā)送java對(duì)象到服務(wù)器

    如何使用HttpClient發(fā)送java對(duì)象到服務(wù)器

    這篇文章主要介紹了如何使用HttpClient發(fā)送java對(duì)象到服務(wù)器,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2019-11-11
  • 關(guān)于Spring?Cache?緩存攔截器(?CacheInterceptor)

    關(guān)于Spring?Cache?緩存攔截器(?CacheInterceptor)

    這篇文章主要介紹了關(guān)于Spring?Cache緩存攔截器(?CacheInterceptor),具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
    2021-12-12
  • Java深入講解異常處理try?catch的使用

    Java深入講解異常處理try?catch的使用

    這篇文章主要介紹了Java異常處理機(jī)制try?catch流程詳解,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下
    2022-06-06
  • SpringBoot加載啟動(dòng)的源碼解析

    SpringBoot加載啟動(dòng)的源碼解析

    這篇文章主要介紹了SpringBoot加載啟動(dòng)的源碼解析,@SpringBootApplication注解是Spring Boot的核心注解,它其實(shí)是一個(gè)組合注解,本身其實(shí)也是一個(gè)IoC容器的配置類,需要的朋友可以參考下
    2023-12-12
  • IDEA2022.2的簡(jiǎn)介、下載與安裝、配置教程

    IDEA2022.2的簡(jiǎn)介、下載與安裝、配置教程

    IDEA是JetBrains公司推出一個(gè)集成開發(fā)工具,是Java開發(fā)工具中的翹楚,基于這個(gè)開發(fā)工具可以快速開發(fā)我們的Java相關(guān)項(xiàng)目,本文重點(diǎn)給大家介紹IDEA2022.2的簡(jiǎn)介、下載與安裝、初步配置,感興趣的朋友一起看看吧
    2022-11-11
  • SpringBoot入門之集成JSP的示例代碼

    SpringBoot入門之集成JSP的示例代碼

    這篇文章主要介紹了SpringBoot入門之集成JSP的示例代碼,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧
    2018-07-07
  • java短網(wǎng)址服務(wù)(TinyURL)生成算法

    java短網(wǎng)址服務(wù)(TinyURL)生成算法

    這篇文章主要為大家詳細(xì)介紹了java短網(wǎng)址服務(wù)生成算法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下
    2018-08-08

最新評(píng)論