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

springboot整合swagger3和knife4j的詳細(xì)過(guò)程

 更新時(shí)間:2022年11月11日 08:59:59   作者:迷失的小鹿  
knife4j的前身是swagger-bootstrap-ui,取名knife4j是希望她能像一把匕首一樣小巧,輕量,并且功能強(qiáng)悍,下面這篇文章主要介紹了springboot整合swagger3和knife4j的詳細(xì)過(guò)程,需要的朋友可以參考下

依賴(lài)

 <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
</dependency>

application.yml配置

  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher ## 解決Failed to start bean ‘documentationPluginsBootstrapper‘ 問(wèn)題
knife4j:
  enable: true

swagger配置類(lèi)

package com.example.springbooth2.config;

import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Value;
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.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableOpenApi//Swagger 開(kāi)啟生成接口文檔功能
public class SwaggerConfig {

    /**
     * ture 啟用Swagger3.0, false 禁用
     */
    @Value("${knife4j.enable}")
    private Boolean enable;

    @Bean
    Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                //配置網(wǎng)站的基本信息
                .apiInfo(apiInfo())
                .enable(enable)
                .select()
                //指定接口的位置
                // RequestHandlerSelectors.basePackage("com.example.springbooth2.controller") 接口的包所在路徑
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                // 指定路徑處理PathSelectors.any()代表所有的路徑
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger3") //接口文檔標(biāo)題
                .description("接口文檔") //接口文檔描述
                //作者信息
                // new Contact("作者","作者URL","作者Email")
                .contact(new Contact("jane", "http://www.baidu.com", "123@qq.com"))
                .version("1.0")//版本
                .build();
    }
}

controller

package com.example.springbooth2.controller;

import com.example.springbooth2.config.ResponseResult;
import com.example.springbooth2.entity.User;
import com.example.springbooth2.service.UserService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;

@Api(tags = "用戶(hù)管理接口")
@RestController
@RequestMapping("/user")
public class UserController {

    @Resource
    private UserService userService;

    @ApiOperation("添加用戶(hù)")
    @ApiImplicitParams({ // 參數(shù)名稱(chēng)
            @ApiImplicitParam(name = "userId", value = "用戶(hù)id"),
            @ApiImplicitParam(name = "userName", value = "用戶(hù)名",  required = true)
    })
    @PostMapping("add")
    public User add(User user) {
        userService.addUser(user);
        return user;
    }

    @ApiOperation("查詢(xún)所有用戶(hù)")
    @GetMapping("list")
    public ResponseResult<User> list() {
        return ResponseResult.success(userService.list());
    }

    @GetMapping("/findOne")
    public ResponseResult<User> findOne() {
        return ResponseResult.success(userService.findById(1));
    }
}

測(cè)試

knife4j訪(fǎng)問(wèn)地址 http://localhost:9090/doc.html

swagger訪(fǎng)問(wèn)地址 http://localhost:9090/swagger-ui/index.html

swagger常用注解說(shuō)明

@Api

用在請(qǐng)求的類(lèi)上

@Api(tags = “該類(lèi)的作用進(jìn)行說(shuō)明”)

@ApiOperation

@ApiOperation(value=“改方法的作用”,note=“備注”)

@ApiImplicitParams

@ApiImplicitParams:用在請(qǐng)求的方法上,表示一組參數(shù)說(shuō)明

@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一個(gè)請(qǐng)求參數(shù)的各個(gè)方面

  • name:參數(shù)名
  • value:參數(shù)的漢字說(shuō)明、解釋
  • required:參數(shù)是否必須傳
  • paramType:參數(shù)放在哪個(gè)地方
  • · header --> 請(qǐng)求參數(shù)的獲?。篅RequestHeader
  • · query --> 請(qǐng)求參數(shù)的獲?。篅RequestParam
  • · path(用于restful接口)–> 請(qǐng)求參數(shù)的獲?。篅PathVariable
  • dataType:參數(shù)類(lèi)型,默認(rèn)String,其它值dataType=“Integer”
  • defaultValue:參數(shù)的默認(rèn)值

多個(gè) @ApiImplicitParam 注解需要放在一個(gè) @ApiImplicitParams 注解中

@ApiImplicitParam 注解中雖然可以指定參數(shù)是必填的,但是卻不能代替 @RequestParam(required = true) ,

前者的必填只是在 Swagger 框架內(nèi)必填,拋棄了 Swagger ,這個(gè)限制就沒(méi)用了,所以假如開(kāi)發(fā)者需要指定一個(gè)參數(shù)必填, @RequestParam(required = true) 注解還是不能省略。

@ApiModel

如果參數(shù)是一個(gè)對(duì)象(例如上文的更新接口),對(duì)于參數(shù)的描述也可以放在實(shí)體類(lèi)中。例如下面一段代碼
@ApiModelProperty:用在屬性上,描述類(lèi)的屬性

@ApiModel(value = "用戶(hù)對(duì)象",description = "用戶(hù)表")
public class User {
    @Id
    @ApiModelProperty(value = "id",required = true)
    private int userId;
    @ApiModelProperty(value = "用戶(hù)名稱(chēng)",required = true)
    private String userName;
}

 總結(jié)

到此這篇關(guān)于springboot整合swagger3和knife4j的文章就介紹到這了,更多相關(guān)springboot整合swagger3和knife4j內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

最新評(píng)論

弋阳县| 资阳市| 鄂托克前旗| 鹿邑县| 宜兰县| 大英县| 大冶市| 梅州市| 浦江县| 桐城市| 江源县| 玉山县| 成安县| 民乐县| 连州市| 莲花县| 辽宁省| 肥乡县| 民权县| 开阳县| 岚皋县| 临邑县| 盘山县| 三明市| 太仆寺旗| 祁门县| 天气| 永安市| 临城县| 绥江县| 新乡市| 华阴市| 神农架林区| 勃利县| 禹城市| 平凉市| 磐安县| 化州市| 柳江县| 鹤岗市| 安庆市|