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

SpringBoot集成Swagger2構(gòu)建在線API文檔的代碼詳解

 更新時間:2020年12月17日 14:16:34   作者:大圣塔.Mrliu  
這篇文章主要介紹了SpringBoot集成Swagger2構(gòu)建在線API文檔,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下

第一部分:代碼集成

pom.xml

<!--swagger2配置-->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>swagger-bootstrap-ui</artifactId>
      <version>1.6</version>
    </dependency>

swagger2配置類

package com.liud.demo.config;

import io.swagger.annotations.ApiOperation;
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;

/**
 * TODO
 * swagger2配置類
 * @author liud
 * @version 1.0
 */

@Configuration
@EnableSwagger2
public class Swagger2 {
  //配置swagger2核心配置
  @Bean
  public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2) //指定api類型位swagger2
        .apiInfo(apiInfo())            //用于定義api文檔匯總信息
        .select()
        //.apis(RequestHandlerSelectors.basePackage("com.liud.demo.controller")) //指定生成文檔的controller
        //.apis(RequestHandlerSelectors.any()) //為任何接口生成API文檔
        //.apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) //為有@Api注解的Controller生成API文檔
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) //為有@ApiOperation注解的方法生成API文檔
        .paths(PathSelectors.any())
        .build();
  }

  //api基本信息
  private ApiInfo apiInfo(){
    return new ApiInfoBuilder()
        .title("SpringBootDemo的項目接口API") //文檔標(biāo)題
        .contact(new Contact("liud", //作者
            "",
            "")) //聯(lián)系人
        .description("SpringBootDemo的項目接口API")//詳細(xì)信息
        .version("1.0.0")//文檔版本號
        .termsOfServiceUrl("")//網(wǎng)站地址
        .build();
  }
}

Controller

package com.liud.demo.controller;

import com.liud.demo.service.HelloService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.*;

import javax.servlet.http.HttpServletRequest;

/**
 * TODO
 *
 * @author liud
 * @version 1.0
 */
@RestController
@Api(tags = {"hello操作接口"})
public class HelloController {
  @ApiOperation(value = "根據(jù)用戶名獲取用戶信息接口")
  @RequestMapping(value = "/getuserinfo",method = RequestMethod.POST)
  public String getUserInfo(HttpServletRequest request,
               @ApiParam(name="username",value = "用戶名",required = true) String username){
    return "輸入的姓名:"+username+",這個用戶的信息已經(jīng)存在!";
  }
}

第二部分 使用 ①原路徑模式

在瀏覽器上輸入url:
http://{ip}:{port}/swagger-ui.html#/

我的地址:http://127.0.0.1:8081/swagger-ui.html

在這里插入圖片描述

②文檔模式

在瀏覽器上輸入url:
http://{ip}:{port}/doc.html

我的地址:http://127.0.0.1:8081/doc.html

在這里插入圖片描述

第三部分 swagger2常用注解

常用注解:

@Api()用于類;
表示標(biāo)識這個類是swagger的資源
tags–表示說明
value–也是說明,可以使用tags替代
但是tags如果有多個值,會生成多個list

在這里插入圖片描述

效果:

在這里插入圖片描述

@ApiOperation()用于方法;
表示一個http請求的操作
value用于方法描述
notes用于提示內(nèi)容
tags可以重新分組(視情況而用)

@ApiParam()用于方法,參數(shù),字段說明;
表示對參數(shù)的添加元數(shù)據(jù)(說明或是否必填等)
name–參數(shù)名
value–參數(shù)說明
required–是否必填

@ApiParam(name="username",value = "用戶名",required = true) String username

效果:

在這里插入圖片描述

  • @ApiModel()用于類
  • 表示對類進(jìn)行說明,用于參數(shù)用實體類接收
  • @ApiModelProperty()用于方法,字段
  • 表示對model屬性的說明或者數(shù)據(jù)操作更改
  • @ApiIgnore()用于類,方法,方法參數(shù)
  • 表示這個方法或者類被忽略
  • @ApiImplicitParam() 用于方法
  • 表示單獨(dú)的請求參數(shù)
  • @ApiImplicitParams() 用于方法,包含多個@ApiImplicitParam

到此這篇關(guān)于SpringBoot集成Swagger2構(gòu)建在線API文檔的文章就介紹到這了,更多相關(guān)SpringBoot集成Swagger2內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

  • Java實現(xiàn)解出世界最難九宮格問題

    Java實現(xiàn)解出世界最難九宮格問題

    這篇文章主要介紹了Java實現(xiàn)解出世界最難九宮格問題,芬蘭數(shù)學(xué)家因卡拉花費(fèi)3個月設(shè)計出了世界上迄今難度最大的數(shù)獨(dú)游戲,而且它只有一個答案,本文使用Java實現(xiàn)解出,需要的朋友可以參考下
    2015-01-01
  • Java8中Stream流求最大值最小值的實現(xiàn)示例

    Java8中Stream流求最大值最小值的實現(xiàn)示例

    本文主要介紹了Java8中Stream流求最大值最小值的實現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2023-04-04
  • Java語言實現(xiàn)掃雷游戲(2)

    Java語言實現(xiàn)掃雷游戲(2)

    這篇文章主要為大家詳細(xì)介紹了Java語言實現(xiàn)掃雷游戲第二部分代碼,文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下
    2020-04-04
  • Springboot集成JAXB返回xml格式

    Springboot集成JAXB返回xml格式

    這篇文章主要為大家詳細(xì)介紹了Springboot如何集成JAXB返回xml格式,文中的示例代碼講解詳細(xì),感興趣的小伙伴可以跟隨小編一起學(xué)習(xí)一下
    2024-12-12
  • SpringBoot使用@Validated處理校驗的方法步驟

    SpringBoot使用@Validated處理校驗的方法步驟

    @Validated?注解的主要目的是啟用和利用?Spring?的驗證框架,它可以用于類上也可以用于方法參數(shù)上,本文給大家介紹了SpringBoot使用@Validated優(yōu)雅的處理校驗的方法步驟,通過代碼示例介紹的非常詳細(xì),需要的朋友可以參考下
    2024-08-08
  • Spring?Cloud?Hystrix?服務(wù)降級限流策略詳解

    Spring?Cloud?Hystrix?服務(wù)降級限流策略詳解

    這篇文章主要為大家介紹了Spring?Cloud?Hystrix?服務(wù)降級限流策略詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪
    2023-01-01
  • springboot集成fastDfs過程代碼實例

    springboot集成fastDfs過程代碼實例

    這篇文章主要介紹了springboot集成fastDfs過程代碼實例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下
    2019-12-12
  • Java單例模式的線程安全,餓漢和懶漢模式詳解

    Java單例模式的線程安全,餓漢和懶漢模式詳解

    這篇文章主要為大家詳細(xì)介紹了Java單例模式的線程安全,餓漢和懶漢模式。文中示例代碼介紹的非常詳細(xì),具有一定的參考價值,感興趣的小伙伴們可以參考一下,希望能夠給你帶來幫助
    2022-02-02
  • Javaweb會話跟蹤技術(shù)Cookie和Session的具體使用

    Javaweb會話跟蹤技術(shù)Cookie和Session的具體使用

    本文主要介紹了Javaweb會話跟蹤技術(shù)Cookie&Session的具體使用,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧
    2022-07-07
  • Spring獲取當(dāng)前類在容器中的beanname實現(xiàn)思路

    Spring獲取當(dāng)前類在容器中的beanname實現(xiàn)思路

    這篇文章主要介紹了Spring獲取當(dāng)前類在容器中的beanname,實現(xiàn)思路只需繼承BeanNameAware接口,本文通過實例代碼給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下
    2022-07-07

最新評論

宜宾市| 商城县| 遂平县| 定远县| 新和县| 白山市| 昌都县| 盱眙县| 湘乡市| 白水县| 五峰| 金门县| 松江区| 青岛市| 庆安县| 乐陵市| 文昌市| 册亨县| 八宿县| 咸丰县| 兖州市| 郸城县| 昭苏县| 镇原县| 永登县| 兴文县| 镇赉县| 望城县| 旅游| 漳浦县| 桃园市| 习水县| 新津县| 七台河市| 伊通| 岑巩县| 额尔古纳市| 汉沽区| 治多县| 都昌县| 南投县|