Springboot swagger配置

最新推荐文章于 2024-07-04 14:45:25 发布

tracy9171

最新推荐文章于 2024-07-04 14:45:25 发布

阅读量166

点赞数 1

CC 4.0 BY-SA版权

分类专栏： config 文章标签： swagger

本文链接：https://blog.youkuaiyun.com/tracy9171/article/details/93519171

config 专栏收录该内容

2 篇文章

订阅专栏

博客介绍了在swagger上设置请求参数，如加入token等。还给出了Swagger2的配置代码，包括pom架包、相关类的导入和配置类的编写。最后提供了启动项目后访问swagger的网址示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

pom架包

io.springfox springfox-swagger2 2.7.0 io.springfox springfox-swagger-ui 2.7.0 　　添加config

其中可以再swagger上设置请求参数，可以加入token等

package com.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

//参考：http://blog.youkuaiyun.com/catoop/article/details/50668896
/**

@author xiebq

*/
@Configuration
@EnableSwagger2
public class Swagger2Config {

@Bean
public Docket createRestApi() {
    List<Parameter> pars = new ArrayList<Parameter>();
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            .paths(PathSelectors.any())
            .build()
            .globalOperationParameters(pars)
            .apiInfo(apiInfo());
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("标题")
            .description("备注信息")
            .termsOfServiceUrl("https://blog.youkuaiyun.com/tracy9171")
            .version("1.0")
            .build();
}

}
　　http://localhost:端口号/swagger-ui.html#! 启动项目数据网址就能点开，我这里是http://localhost:8081/swagger-ui.html#!