前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >API管理-基于SpringBoot项目集成swagger实现接口文档自动生成

API管理-基于SpringBoot项目集成swagger实现接口文档自动生成

作者头像
秋日芒草
发布2019-06-24 10:41:56
1.2K0
发布2019-06-24 10:41:56
举报
文章被收录于专栏:JavaWebJavaWeb

1. 为什么要使用swagger?

上一次博客(API管理-使用开源xxl-api项目管理接口)中我也提到过接口文档在整个生命周期中的重要性以及使用开源xxl-api的优缺点,缺点就是没法自动完成接口文档的生成,而是手动的录入,这样的话跟我们传统的通过编写word来管理接口文档也没什么区别;而swagger却是通过开发者在编写接口的时候就已经通过指定的注解标注好接口的信息,在启动的时候swagger会自动生成对应的接口文档。

2. SpringBoot配置使用方式

  • 配置pom.xml依赖
代码语言:javascript
复制
<!-- swagger2 -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger2</artifactId>
	<version>2.9.2</version>
   <!--  <version>2.8.0</version> -->
</dependency>

<!-- springfox-swagger原生ui  -->
<dependency>
	<groupId>io.springfox</groupId>
	<artifactId>springfox-swagger-ui</artifactId>
	<version>2.9.2</version>
</dependency>
  • 配置SwaggerConfig类
代码语言:javascript
复制
@Configuration
@EnableSwagger2
public class SwaggerConfig {
	
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.api.rest.controller"))
                .paths(PathSelectors.any())
                .build();
//                .build().enable(false); // 线上关闭接口
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("智慧卫检-监督员系统")
                .description("监管系统")
                .termsOfServiceUrl("http://www.zhihuiweijian.com/")
                //.contact(contact)
                .version("1.0")
                .build();
    }

}
  • 配置MvcConfig类
代码语言:javascript
复制
@Configuration
public class MvcConfig extends WebMvcConfigurationSupport {

	/**
	*
	* 功能描述:
	*  配置静态资源,避免静态资源请求被拦截
	* @auther: Tt(yehuawei)
	* @date:
	* @param:
	* @return:
	*/
	public void addResourceHandlers(ResourceHandlerRegistry registry) {
	   //如果静态文件放到了classpath 下,就如下配置。
	   registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");

	   /*放行swagger*/
	   registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
	   registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
	   super.addResourceHandlers(registry);
	}
}
  • 以规定的注解编写接口信息
代码语言:javascript
复制
@ApiOperation(value="账号密码登录", notes="账号密码登录")
@ApiImplicitParams({
	@ApiImplicitParam(name = "mobile", value = "账号", required = true, dataType = "String"),
	@ApiImplicitParam(name = "password", value = "密码", required = true, dataType = "String")
})
@RequestMapping(value="accountLogin")
public ApiCommonResultVo login(String mobile, String password) {}
  • 启动项目、访问地址、查看接口信息:http://localhost:8080/swagger-ui.html
  • 效果图

3. 总结

Swagger API 接口文档生成工具的利与弊,对于使用swagger利弊这边文章已经解释的很清楚了,虽然通过这种方式集成swagger后有一个统一的接口可以查看接口信息了,但这个springfox-swagger-ui版本的并不支持接口文档的下载以便于离线查看,还有就是原生的ui使用起来总感觉不顺手,所以又有人基于swagger的接口方式自定义开发了基于bootstrap的ui并扩展了部分功能,详细请参考博客:API管理-舍弃springfox-swagger-ui,采用功能更加丰富的swagger-bootstrap-ui

代码语言:txt
复制
 (adsbygoogle = window.adsbygoogle || []).push({});
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
项目管理
CODING 项目管理(CODING Project Management,CODING-PM)工具包含迭代管理、需求管理、任务管理、缺陷管理、文件/wiki 等功能,适用于研发团队进行项目管理或敏捷开发实践。结合敏捷研发理念,帮助您对产品进行迭代规划,让每个迭代中的需求、任务、缺陷无障碍沟通流转, 让项目开发过程风险可控,达到可持续性快速迭代。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档