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

Spring MVC集成springfox-swagger2構建restful API的方法詳解

 更新時間:2017年06月13日 11:31:15   作者:興國First  
這篇文章主要給大家介紹了關于Spring MVC集成springfox-swagger2構建restful API的相關資料,文中介紹介紹的非常詳細,需要的朋友可以參考借鑒,下面來一起看看吧。

前言

在集成springfox-swagger2之前,我也嘗試著集成了swagger-springmvc,方式差不多,但是swagger-springmvc相對麻煩一點,因為要把它的靜態(tài)文件copy到自己的項目中。所以還是用新版本的。

至于兩者有什么不同,為什么進行版本變更請參見官方說明文檔

方法如下

這里先寫下需要的pom.xml配置(我引用的2.4.0,相對穩(wěn)定)

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

還需要在spring-mvc.xml中添加映射靜態(tài)的配置:

<mvc:default-servlet-handler />

然后就是swagger2的配置類:

package com.xingguo.logistics.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

 @Bean
 public Docket buildDocket(){
 return new Docket(DocumentationType.SWAGGER_2)
  .apiInfo(buildApiInf())
  .select() .apis(RequestHandlerSelectors.basePackage("com.xingguo.logistics.controller"))//controller路徑
  .paths(PathSelectors.any())
  .build();
 }

 private ApiInfo buildApiInf(){
 return new ApiInfoBuilder()
  .title("xingguo大標題")
  .termsOfServiceUrl("http://blog.csdn.net/u014231523網(wǎng)址鏈接")
  .description("springmvc swagger2")
  .contact(new Contact("diaoxingguo", "http://blog.csdn.net/u014231523", "diaoxingguo@163.com"))
  .build();

 }
}

然后運行項目,輸入自己的url。

http://{ip}:{port}/{projectname}/swagger-ui.html#/

我的url:

http://localhost:8989/logistics/swagger-ui.html#/

然后就可以看到效果圖:


它會把按照controller,把所有的接口都加載進來。

我的目錄結構如圖:

然后,就是接口名稱和參數(shù)的說明:

常用注解:

      - @Api()用于類名

      - @ApiOperation()用于方法名

      - @ApiParam()用于參數(shù)說明

      - @ApiModel()用于實體類

      - @ApiModelProperty用于實體類屬性

更詳細的說明請參見官方注解說明文檔

使用方法如圖:

@Controller
//類上使用@Api
@Api(value="用戶controller",description="用戶相關操作")
public class UserController {

 @RequestMapping(value="index",method=RequestMethod.POST)
 //方法上使用@ApiOperation
 @ApiOperation(value="首頁",notes="跳轉到首頁")
 //參數(shù)使用@ApiParam
 public Object getIndex(@ApiParam(name="topic實體",value="json格式",required=true) @RequestBody Topic topic){
 //業(yè)務內(nèi)容,被我刪除了,請忽略,主要看上面的注解
 Object obj = new Object();
 return obj;
 }
}
//一般添加個@ApiModel()就可以,看情況使用里面的屬性
@ApiModel(value="Topic", discriminator = "foo", subTypes = {Topic.class})
public class Topic{

}

效果圖如下:

我在springboot中也集成了swagger2,集成方式基本相同,使用方式也基本一樣。請參考Spring Boot集成springfox-swagger2構建restful API的方法教程

總結

以上就是這篇文章的全部內(nèi)容了,希望本文的內(nèi)容對大家的學習或者工作能帶來一定的幫助,如有疑問大家可以留言交流,謝謝大家對腳本之家的支持。

相關文章

  • SpringCloud學習筆記之Feign遠程調(diào)用

    SpringCloud學習筆記之Feign遠程調(diào)用

    Feign是一個聲明式的http客戶端。其作用就是幫助我們優(yōu)雅的實現(xiàn)http請求的發(fā)送。本文將具體為大家介紹一下Feign的遠程調(diào)用,感興趣的可以了解一下
    2021-12-12
  • Spring?Boot實現(xiàn)消息的發(fā)送和接收使用實戰(zhàn)指南

    Spring?Boot實現(xiàn)消息的發(fā)送和接收使用實戰(zhàn)指南

    這篇文章主要為大家介紹了Spring?Boot實現(xiàn)消息的發(fā)送和接收使用實戰(zhàn)指南,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
    2023-06-06
  • 詳解Java的按位操作符

    詳解Java的按位操作符

    Java的位操作符用來操作整數(shù)基本數(shù)據(jù)類型中的單個“比特”(bit),即代進制位。下面通過本文給大家分享Java的按位操作符,感興趣的朋友一起看看吧
    2017-09-09
  • mybatis省略@Param注解操作

    mybatis省略@Param注解操作

    這篇文章主要介紹了mybatis省略@Param注解操作,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧
    2020-11-11
  • Java8函數(shù)式接口java.util.function速查大全

    Java8函數(shù)式接口java.util.function速查大全

    因為Java8引入了函數(shù)式接口,在java.util.function包含了幾大類函數(shù)式接口聲明,這篇文章主要給大家介紹了關于Java8函數(shù)式接口java.util.function速查的相關資料,需要的朋友可以參考下
    2021-08-08
  • Java?將list集合數(shù)據(jù)按照時間字段排序的方法

    Java?將list集合數(shù)據(jù)按照時間字段排序的方法

    這篇文章主要介紹了Java?將list集合數(shù)據(jù)按照時間字段排序,本文通過示例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2023-03-03
  • Java異步調(diào)用轉同步方法實例詳解

    Java異步調(diào)用轉同步方法實例詳解

    這篇文章主要介紹了Java異步調(diào)用轉同步方法實例詳解,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
    2020-06-06
  • JAVA?GUI基礎與MouseListener用法

    JAVA?GUI基礎與MouseListener用法

    這篇文章主要介紹了JAVA?GUI基礎與MouseListener用法,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教
    2021-12-12
  • 深入淺出JAVA MyBatis-快速入門

    深入淺出JAVA MyBatis-快速入門

    這篇文章主要介紹了在今天這篇博文中,我將要介紹一下mybatis的框架原理,以及mybatis的入門程序,實現(xiàn)用戶的增刪改查,她有什么優(yōu)缺點以及mybatis和hibernate之間存在著怎么樣的關系,大家這些問題一起通過本文學習吧
    2021-06-06
  • Maven一鍵部署Springboot到Docker倉庫為自動化做準備(推薦)

    Maven一鍵部署Springboot到Docker倉庫為自動化做準備(推薦)

    這篇文章主要介紹了Maven一鍵部署Springboot到Docker倉庫,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2020-07-07

最新評論