Springboot整合swagger2,包括修改swagger可视化界面和界面汉化处理
Springboot整合swagger2,包括修改swagger可视化界面和界面汉化处理
swagger配置类编写
package com.ruiec.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
/**
- swagger配置类
- @author luo_wei
- @date 2019年5月8日 下午2:13:17
*/
@Configuration
//@EnableSwagger2 //启用Swagger2
public class SwaggerApi {
/**
- 创建Docket的Bean之后
- @author luo_wei
- @date 2019年5月8日 下午2:10:26
*/
@Bean
public Docket createRestApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().
apis(RequestHandlerSelectors.basePackage("com.ruiec.controller")).paths(PathSelectors.any()).build();
}
/**
- 创建该Api的基本信息（这些基本信息会展现在文档页面中）
- @ApiIgnore无视
- @author luo_wei
- @date 2019年5月8日 下午2:10:32
*/
@SuppressWarnings("deprecation")
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("大数据BI-JAVA部门对接项目").description("BI-前端api接口界面")
.termsOfServiceUrl("http://192.168.20.215:8081/swagger-ui.html").contact("罗巍").version("1.0.0").build();
}
}
jar包引入
io.springfox
springfox-swagger-ui
2.7.0
org.reflections
reflections
0.9.11
src\main\resources\META-INF\resources\webjars\springfox-swagger-ui\lang\zh-cn.js（增加此js，可以将默认的英文换成中文）
'use strict';
/* jshint quotmark: double */
window.SwaggerTranslator.learn({
"Warning: Deprecated":"警告：已过时",
"Implementation Notes":"实现备注",
"Response Class":"响应类",
"Status":"状态",
"Parameters":"参数",
"Parameter":"参数",
"Value":"值",
"Description":"描述",
"Parameter Type":"参数类型",
"Data Type":"数据类型",
"Response Messages":"响应消息",
"HTTP Status Code":"HTTP状态码",
"Reason":"原因",
"Response Model":"响应模型",
"Request URL":"请求URL",
"Response Body":"响应体",
"Response Code":"响应码",
"Response Headers":"响应头",
"Hide Response":"隐藏响应",
"Headers":"头",
"Try it out!":"试一下！",
"Show/Hide":"显示/隐藏",
"List Operations":"显示操作",
"Expand Operations":"展开操作",
"Raw":"原始",
"can't parse JSON. Raw result":"无法解析JSON. 原始结果",
"Example Value":"示例",
"Click to set as parameter value":"点击设置参数",
"Model Schema":"模型架构",
"Model":"模型",
"apply":"应用",
"Username":"用户名",
"Password":"密码",
"Terms of service":"服务条款",
"Created by":"创建者",
"See more at":"查看更多：",
"Contact the developer":"联系开发者",
"api version":"api版本",
"Response Content Type":"响应Content Type",
"Parameter content type:":"参数类型:",
"fetching resource":"正在获取资源",
"fetching resource list":"正在获取资源列表",
"Explore":"浏览",
"Show Swagger Petstore Example Apis":"显示 Swagger Petstore 示例 Apis",
"Can't read from server. It may not have the appropriate access-control-origin settings.":"无法从服务器读取。可能没有正确设置access-control-origin。",
"Please specify the protocol for":"请指定协议：",
"Can't read swagger JSON from":"无法读取swagger JSON于",
"Finished Loading Resource Information. Rendering Swagger UI":"已加载资源信息。正在渲染Swagger UI",
"Unable to read api":"无法读取api",
"from path":"从路径",
"server returned":"服务器返回"
});
src\main\resources\META-INF\resources\swagger-ui.html （修改此文件可以替换swagger的接口展示界面）
Swagger UI