简单实现springboot集成swagger

6 篇文章 0 订阅
4 篇文章 0 订阅

属于自己的文档,只用于简单参考。

添加依赖

<!--swagger2的依赖-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.9.2</version>
		</dependency>

添加Swagger配置

@Configuration
@EnableSwagger2  //开启swagger
public class SwaggerConfig{
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // basePackage() 配置要为哪个包下的接口生成api文档
                // withMethodAnnotation(ApiOperation.class) 给添加了该注解的方法生成接口文档
                // any() 给任意方法生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.cai.primeton.controller"))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        Contact contact = new Contact("csp","","13298280305@163.com");
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("添加描述")
                .contact(contact)
                .version("1.0")
                .build();
    }
}

常用注解

@Api()
	属性:tags = “”
@ApiOperation()  标注在要生成接口文档的方法上
	属性:value = ""  方法说明
@ApiImplicitParam() 标注在要生成接口文档的方法上,用户介绍参数
	属性: name = ""  参数名
		        value = ""   参数说明

测试

http://localhost:8085/swagger-ui.html

在这里插入图片描述

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值