栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Spring Boot 配置Swagger 3

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Spring Boot 配置Swagger 3

1 Maven依赖
        
        
            io.springfox
            springfox-boot-starter
            3.0.0
        
2 SwaggerConfig

        Swagger3配置类。

package com.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.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.documentationType;
import springfox.documentation.spring.web.plugins.Docket;


@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket defaultApi() {
        return new Docket(documentationType.OAS_30)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select()
                // 选择那些路径和api会生成document
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口文档")
                //描述
                .description("项目接口文档")
                .version("1.0")
                .build();
    }

}
3 调试代码
package com.controller;

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.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(tags = "Swagger测试接口", value = "swagger")
public class SwaggerController {
    @ApiOperation("测试")
    @ApiImplicitParams({
            @ApiImplicitParam(value = "参数1", name = "arg1", paramType = "query", required = true, dataType = "String"),
            @ApiImplicitParam(value = "参数2", name = "arg2", paramType = "query", required = true, dataType = "String"),
    })
    @GetMapping("test")
    public String test(@RequestParam String arg1, @RequestParam String arg2) {
        return arg1 + arg2;
    }
}
 4 Swagger3调试页面

        输入以下地址,即可打开Swagger页面,查看接口描述。http://localhost:8080/swagger-ui/index.htmlhttp://localhost:8081/swagger-ui/index.html

 

转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/332051.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号