java springboot集成swagger2

1 maven引用,此处只列出swagger的配置

<!-- 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>

2 创建java文件,编写config信息

@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable",  havingValue = "true")
public class SwaggerConfig {
	public static final String LOGIN_TAG = "loginTag";
	public static final String USER_TAG = "userTag";
	public static final String MENU_TAG = "menuTag";
	public static final String ORG_TAG = "orgTag";
	public static final String DIC_TAG = "dicTag";
	public static final String CONFIG_TAG = "configTag";
	
	@Bean
	public Docket createRestApi() {
		ParameterBuilder tokenPar = new ParameterBuilder();
		List<Parameter> pars = new ArrayList<>();
        tokenPar.name(ParamCommon.TOKEN).description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).tags(new Tag(LOGIN_TAG, "登陆的rest接口"), 
				new Tag(USER_TAG, "用户的rest接口"),
				new Tag(MENU_TAG, "菜单的rest接口"),
				new Tag(ORG_TAG, "机构的rest接口"),
				new Tag(DIC_TAG, "数据字段的rest接口"),
				new Tag(CONFIG_TAG, "配置信息的rest接口"))
				.select()
				.apis(RequestHandlerSelectors.basePackage("com.supply.chain"))// 扫描的单包路径
				.paths(PathSelectors.any()).build()
				.globalOperationParameters(pars);//这里需要注意些
	}

	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("API接口 ").description("SINGLETABLE-POPUPEDIT REST API")
				.version("0.0.1-SNAPSHOT").build();
	}
}

3 application.properties增加配置信息,用来在生产环境关闭此配置实用

swagger.enable=true

4 在controller中增加对应的标签
在这里插入图片描述
在这里插入图片描述

5 启动后,使用http://localhost:8080/swagger-ui.html访问对应的接口信息
在这里插入图片描述
6 如果框架集成了shiro/spring security等,需要将配置一下,否则是访问不到的

/swagger-ui.html=anon
/webjars/**=anon
/v2/**=anon
/swagger-resources/**=anon

完成!

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值