业务规范（整合swagger2）

###业务规范之springboot整合swagger2
###业务规范之统一验证
###业务规范之统一返回体
###业务规范之统一异常处理和统一响应

二、整合swagger2

这里用到swagger2：

导入jar包：

 <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.8.0</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.8.0</version></dependency>

swagger2配置：

//@Profile({"dev", "test"})// 设置 dev test 环境开启 prod 环境就关闭了
@Configuration
@EnableSwagger2
public class Swagger2Config {//api接口包扫描路径public static final String SWAGGER_SCAN_BASE_PACKAGE = "cn.mesmile.demo.model";public static final String VERSION = "1.0.0";@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2).host("127.0.0.1:8080").apiInfo(apiInfo())// 是否开启swagger.enable(true).select().apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE))// 可以根据url路径设置哪些请求加入文档，忽略哪些请求.paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("练习demo").description("单词计数服务 API 接口文档") // 设置文档的描述.version(VERSION).termsOfServiceUrl("http://www.mesmile.cn").build();}
}

前后端跨越以及swagger映射配置:

@Configuration
public class CorsConfig extends WebMvcConfigurationSupport {/*** 解决跨越的问题* @param registry*/@Overridepublic void addCorsMappings(CorsRegistry registry) {registry.addMapping("/**")//允许跨域的域名，可以用*表示允许任何域名使用.allowedOrigins("*")//允许任何方法（post、get等）.allowedMethods("GET","HEAD","POST","PUT","DELETE","OPTIONS")//带上cookie信息.allowCredentials(true)//允许任何请求头.allowedHeaders("*")//maxAge(3600)表明在3600秒内，不需要再发送预检验请求，可以缓存该结果.maxAge(3600);}/*** swagger 资源映射*/@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}//解决中文乱码问题@Beanpublic HttpMessageConverter<String> responseBodyConverter() {StringHttpMessageConverter converter = new StringHttpMessageConverter(Charset.forName("UTF-8"));return converter;}@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) {super.configureMessageConverters(converters);converters.add(responseBodyConverter());}}

业务规范之springboot整合swagger2相关推荐

SpringBoot学习笔记(16)----SpringBoot整合Swagger2
Swagger 是一个规范和完整的框架,用于生成,描述,调用和可视化RESTful风格的web服务 http://swagger.io Springfox的前身是swagger-springmvc,是 ...
Swagger的安装以及SpringBoot整合Swagger2实现SwaggerAPI文档测试
前言本篇博客是本人在网上学习Swagger所产出的个人笔记.主要内容有: 1.Swagger的安装 2.Swagger的介绍 3.Swagger2中常用的注解 4.快速上手案例准备工作:Swagg ...
springboot整合 swagger2
springboot整合 swagger2 引入依赖 <dependency><groupId>io.springfox</g ...
SpringBoot整合Swagger2教程
SpringBoot整合Swagger2教程环境说明 springboot 版本 2.4.4 swagger2 版本 2.9.2 工程准备创建Springboot工程.这一步不会的可先去Hello ...
SpringBoot整合Swagger2
整合Swagger2 1.Swagger介绍前后端分离开发模式中,api文档是最好的沟通方式. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web ...
springboot 整合 swagger2 配置账号密码登录 demo代码
配置spring security登录可参考: springboot整合spring security安全框架-简单验证账号密码一.pom文件引入swagger依赖 <!-- swagger2 ...
SpringBoot整合Swagger2实现接口文档
展示一下访问方式一访问地址:http://localhost:8080/swagger-ui.html#/ 首页详情页访问方式二访问地址:http://localhost:8080/doc. ...
springboot整合swagger2之最佳实践
来源:https://blog.lqdev.cn/2018/07/21/springboot/chapter-ten/ Swagger是一款RESTful接口的文档在线自动生成.功能测试功能框架. 一 ...
SpringBoot 整合 Swagger2 + Knife4j
文章目录写在最前面代码 1. 准备项目 2. 配置类 3. 控制器类(进行测试) 4. 启动器网页查看效果写在最前面 SpringBoot 项目,一般会提供一大堆的 Controller 来供 ...

业务规范之springboot整合swagger2

业务规范（整合swagger2）

二、整合swagger2

业务规范之springboot整合swagger2相关推荐

最新文章

热门文章