SpringBoot学习笔记之集成swagger

Swagger2在SpringBoot环境下的应用

合并步骤

第四章 springboot + swagger,springbootswagger

注:本文参考自

 

swagger用于定义API文书档案。

好处:

  • 上下端分离开发
  • API文书档案万分显眼
  • 测试的时候不必要再利用UCRUISERL输入浏览器的法门来走访Controller
  • 价值观的输入U奥迪Q5L的测试方法对于post请求的传参比较费心(当然,能够采取postman这样的浏览器插件)
  • spring-boot与swagger的合龙简单的一逼

壹 、项目布局

和上一节一样,没有改变。

2、pom.xml

引入了三个jar。

图片 1 1
<dependency> 2 <groupId>io.springfox</groupId> 3
<artifactId>springfox-swagger2</artifactId> 4
<version>2.2.2</version> 5 </dependency> 6
<dependency> 7 <groupId>io.springfox</groupId> 8
<artifactId>springfox-swagger-ui</artifactId> 9
<version>2.2.2</version> 10 </dependency> View Code

3、Application.java

图片 2 1 package
com.xxx.firstboot; 2 3 import
org.springframework.boot.SpringApplication; 4 import
org.springframework.boot.autoconfigure.SpringBootApplication; 5 6 import
springfox.documentation.swagger2.annotations.EnableSwagger2; 7 8
@SpringBootApplication //same as
@[email protected][email protected]
9 @EnableSwagger2 //启动swagger注解 10 public class Application { 11 12
public static void main(String[] args) { 13
SpringApplication.run(Application.class, args); 14 } 15 16 } View Code

说明:

  • 引入了二个诠释@EnableSwagger2来运营swagger注解。(运行该注明使得用在controller中的swagger注脚生效,覆盖的限定由@ComponentScan的陈设来钦点,那里暗许钦点为根路径”com.xxx.firstboot”下的持有controller)

4、UserController.java

图片 3 1 package
com.xxx.firstboot.web; 2 3 import
org.springframework.beans.factory.annotation.Autowired; 4 import
org.springframework.web.bind.annotation.RequestHeader; 5 import
org.springframework.web.bind.annotation.RequestMapping; 6 import
org.springframework.web.bind.annotation.RequestMethod; 7 import
org.springframework.web.bind.annotation.RequestParam; 8 import
org.springframework.web.bind.annotation.RestController; 9 10 import
com.xxx.firstboot.domain.User; 11 import
com.xxx.firstboot.service.UserService; 12 13 import
io.swagger.annotations.Api; 14 import
io.swagger.annotations.ApiImplicitParam; 15 import
io.swagger.annotations.ApiImplicitParams; 16 import
io.swagger.annotations.ApiOperation; 17 import
io.swagger.annotations.ApiResponse; 18 import
io.swagger.annotations.ApiResponses; 19 20 @RestController 21
@RequestMapping(“/user”) 22 @Api(“userController相关api”) 23 public
class UserController { 24 25 @Autowired 26 private UserServiceuserService; 27 28 // @Autowired 29 // private MyRedisTemplate
myRedisTemplate; 30 31 @ApiOperation(“获取用户新闻”) 32
@ApiImplicitParams({ 33
@ApiImplicitParam(paramType=”header”,name=”username”,dataType=”String”,required=true,value=”用户的姓名”,defaultValue=”zhaojigang”),
34
@ApiImplicitParam(paramType=”query”,name=”password”,dataType=”String”,required=true,value=”用户的密码”,defaultValue=”wangna”)
35 }) 36 @ApiResponses({ 37
@ApiResponse(code=400,message=”请求参数没填好”), 38
@ApiResponse(code=404,message=”请求路径没有或页面跳转路径不对”) 39 }) 40
@RequestMapping(value=”/getUser”,method=RequestMethod.GET) 41 public
User getUser(@RequestHeader(“username”) String username,
@RequestParam(“password”) String password) { 42 return
userService.getUser(username,password); 43 } 44 45 //
@RequestMapping(“/testJedisCluster”) 46 // public User
testJedisCluster(@RequestParam(“username”) String username){ 47 //
String value =
myRedisTemplate.get(MyConstants.USE中华V_FORWARD_CACHE_PREFIX, username);
48 // if(StringUtils.isBlank(value)){ 49 //
myRedisTemplate.set(MyConstants.USER_FORWARD_CACHE_PREFIX, username,
JSON.toJSONString(getUser())); 50 // return null; 51 // } 52 // return
JSON.parseObject(value, User.class); 53 // } 54 55 } View Code

说明:

  • @Api:用在类上,表明该类的成效
  • @ApiOperation:用在章程上,表明方法的作用
  • @ApiImplicitParams:用在情势上含蓄一组参数表明
  • @ApiImplicitParam:用在@ApiImplicitParams表明中,钦点两个呼吁参数的各种方面
    • paramType:参数放在哪个地方
      • header–>请求参数的拿走:@RequestHeader
      • query–>请求参数的获得:@RequestParam
      • path(用于restful接口)–>请求参数的收获:@PathVariable
      • body(不常用)
      • form(不常用)
    • name:参数名
    • dataType:参数类型
    • required:参数是或不是必须传
    • value:参数的意味
    • defaultValue:参数的默许值
  • @ApiResponses:用于表示一组响应
  • @ApiResponse:用在@ApiResponses中,一般用于表达三个荒谬的响应信息
    • code:数字,例如400
    • message:新闻,例如”请求参数没填好”
    • response:抛出十三分的类

上述那一个就是最常用的多少个申明了。

切切实实别的的注释,查看:

 

测试:

起步服务,浏览器输入””

图片 4

最上面三个红框:@Api

GET红框:method=RequestMethod.GET

左侧红框:@ApiOperation

parameter红框:@ApiImplicitParams体系申明

response messages红框:@ApiResponses类别注明

输入参数后,点击”try it out!”,查看响应内容:

图片 5

 

springboot + swagger,springbootswagger
注:本文参考自
swagger用于定义API文书档案。 好处: 前后端分离开发 API文书档案…

1. 集成Swagger

壹 、在pom.xml中引费用swagger重视包

1.1 添加正视

<!–swagger2 start–>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger2</artifactId>

<version>2.6.1</version>

</dependency>

<!–引入swagger-ui包–>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-swagger-ui</artifactId>

<version>2.6.1</version>

</dependency>

 

<dependency>

1.2 配置类

package com.inn.demo.config;

 

import org.springframework.beans.factory.annotation.Value;

import org.springframework.context.annotation.Bean;

import org.springframework.context.annotation.Configuration;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

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;

import springfox.documentation.swagger2.annotations.EnableSwagger2;

 

@Configuration

@EnableSwagger2

public class SwaggerConfiguration extends WebMvcConfigurerAdapter {

//生产关闭swagger

@Value(“${swagger.enable}”)

private boolean enableSwagger;

 

// /**

// * 访问swagger ui
出现404时能够把注释去掉试试

// * 消除能源系统能源目录与swagger
ui能源目录争辨难点

// *
那些地点要再度注入一下财富文件,不然不会注入财富的,也尚无流入requestHandlerMappping,约等于xml配置的swagger能源配置

// * <mvc:resources
location=”classpath:/META-INF/resources/”
mapping=”swagger-ui.html”/>

// * <mvc:resources
location=”classpath:/META-INF/resources/webjars/”
mapping=”/webjars/**”/>

// * @param registry

// */

// @Override

// public void
addResourceHandlers(ResourceHandlerRegistry registry) {

//
registry.addResourceHandler(“/**”).addResourceLocations(“classpath:/static/”);

//
registry.addResourceHandler(“swagger-ui.html”)

//
.addResourceLocations(“classpath:/META-INF/resources/”);

// registry.addResourceHandler(“/webjars/**”)

//
.addResourceLocations(“classpath:/META-INF/resources/webjars/”);

// super.addResourceHandlers(registry);

// }

 

// /**

// * 协助分组 groupName

// */

// @Bean(value = “solrRestApi”)

// public Docket createSolrRestApi() {

// return new
Docket(DocumentationType.SWAGGER_2)

// .apiInfo(apiInfo()).groupName(“Solr
Demo模块”)

// .enable(enableSwagger)

// .select()

//
.apis(RequestHandlerSelectors.basePackage(“com.inn.demo.modules.solr.web”))

// .paths(PathSelectors.any())

// .build();

// }

 

@Bean(value = “userRestApi”)

public Docket createUserRestApi()
{

return new Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

//.groupName(“用户管理”)

.enable(enableSwagger)

.globalOperationParameters(createCommonParams())//公共参数

.select()

.apis(RequestHandlerSelectors.basePackage(“com.inn.demo.modules.user.web”))

.paths(PathSelectors.any())

.build();

}

 

private ApiInfo apiInfo()
{

return new ApiInfoBuilder()

.title(“Demo APIs”)

.description(“应用实例”)

//.termsOfServiceUrl(“;)

//.contact(new Contact(“开发者1”, “”,
xxx@163.com“))

.version(“1.0”)

.build();

}

/**
 * 创建公共参数
 * @return
 */
private List<Parameter> createCommonParams() {
    //添加head参数start
    List<Parameter> pars = new ArrayList<Parameter>();

    ParameterBuilder tokenPar = new ParameterBuilder();
    tokenPar.name("x-access-token").description("令牌").modelRef(new ModelRef("string")).parameterType("header").required(false).build();

    pars.add(tokenPar.build());

    return pars;
    //添加head参数end
}

}

 

<groupId>io.springfox</groupId>

1.3 表明使用

作用范围

API

选取地点

对象属性

@ApiModelProperty

用在出入参数对象的字段上

商业事务集讲述

@Api

用于controller类上

协和式飞机描述

@ApiOperation

用在controller的法子上

Response集

@ApiResponses

用在controller的点子上

Response

@ApiResponse

用在 @ApiResponses里边

非对象参数集

@ApiImplicitParams

用在controller的章程上

非对象参数描述

@ApiImplicitParam

用在@ApiImplicitParams的格局里边

讲述再次来到对象的含义

@ApiModel

用在回到对象类上

ApiImplicitParam的连带属性

属性

取值

作用

paramType

path

query

body

header

form

参数放在哪个地方:必须求有这几个天性

header:header中提交:@RequestHeader获取

query :key=value提交:@RequestParam获取

path  :地址中提交:@PathVariable获取

body  :json流提交 :@RequestBody获取(限POST)

form  :表单提交:@RequestParam获取(限POST)

dataType

Long

String

参数的数据类型 只作为标志认证,并不曾实际验证

name

 

接受参数名

value

 

吸收接纳参数的意思描述

required

 

参数是不是必填

 

TRUE

必填

 

FALSE

非必填

defaultValue

 

默认值

ApiImplicitParam 与 ApiParam 的区别

ApiImplicitParam: 

  • 对Servlets恐怕非 JAX-HighlanderS的条件,只可以利用 ApiImplicitParam。
  • 在利用上,ApiImplicitParam比ApiParam具有更少的代码侵入性,只要写在点子上就足以了,可是须要提供切实的习性才能匹配swagger
    ui解析使用。
  • ApiParam只须要较少的品质,与swagger ui协作更好。

 

代码实例:

@RestController

@RequestMapping(value = “/user”)

@Api(value = “/user”, description = “职员基本音信 “)

public class UserController
{

 

static Map<String, User> users = Collections.synchronizedMap(new HashMap<String,
User>());

 

@ApiOperation(value = “获取用户列表”, notes = “”)

@RequestMapping(value = {“/list”}, method = RequestMethod.GET)

public List<User>
getUserList() {

List<User> r = new ArrayList<User>(users.values());

return r;

}

 

@ApiOperation(value = “创造用户”, notes = “依据User对象成立用户”)

@ApiImplicitParam(name = “user”, value = “用户详细实体user”, required = true, dataType = “User”)

@RequestMapping(value = “add”, method = RequestMethod.POST)

public String postUser(@RequestBody User user)
{

users.put(user.getId(),
user);

return “success”;

}

 

@ApiOperation(value = “获取用户详细新闻”, notes = “依照url的id来获得用户详细消息”)

@ApiParam(name = “id”, value = “用户ID”, required = true)

@RequestMapping(value = “/get/{id}”, method = RequestMethod.GET)

public User getUser(@PathVariable(value = “id”) String id)
{

return users.get(id);

}

 

@ApiOperation(value = “更新用户详细音讯”, notes = “依照url的id来钦命更新指标,并依照传过来的user音信来更新用户详细消息”)

@RequestMapping(value = “/update/{id}”, method =
RequestMethod.PUT)

public String putUser(@PathVariable @ApiParam(name = “id”, value = “用户ID”, required = true) String
id,

@RequestBody @ApiParam(name = “user”, value = “用户详细实体user”, required = true) User user)
{

User u = users.get(id);

u.setName(user.getName());

u.setAge(user.getAge());

users.put(id, u);

return “success”;

}

 

@ApiOperation(value = “更新用户名称和年龄”, notes = “更新用户名称和年龄”)

@ApiImplicitParams({

@ApiImplicitParam(name = “id”, value = “用户ID”, required = true, dataType = “String”,paramType = “path”),

@ApiImplicitParam(name = “name”, value = “用户名”, required = true, dataType = “String”,paramType = “query”),

@ApiImplicitParam(name = “age”, value = “年龄”, required = true, dataType = “Integer”,paramType = “query”),

@ApiImplicitParam(name = “user”, value = “用户音信”, required = true, dataType = “User”,paramType = “body”),

@ApiImplicitParam(name = “headerName”, value = “Header信息”, required = true, dataType = “String”,paramType = “header”)

})

@RequestMapping(value = “/update/info/{id}”, method =
RequestMethod.POST)

public String
updateUserNameAndAge(@PathVariable(value = “id”) String
id,

@RequestParam(value = “name”) String
name,

@RequestParam(value = “age”) Integer
age,

@RequestHeader(value = “headerName”) String
headerName,

@RequestBody User user)
{

User u = users.get(id);

u.setName(name);

u.setAge(age);

users.put(id, u);

return “success”;

}

 

@ApiOperation(value = “删除用户”, notes = “依照url的id来内定删除对象”)

@ApiParam(name = “id”, value = “用户ID”, required = true)

@RequestMapping(value = “/delete/{id}”, method =
RequestMethod.DELETE)

public String deleteUser(@PathVariable String id)
{

users.remove(id);

return “success”;

}

 

@ApiOperation(value=”删除用户-传递数组”, notes=”删除对象,传递数组”)

@RequestMapping(value=”/users/deleteByIds”, method =
RequestMethod.DELETE)

public void deleteUsers(@ApiParam(“用户ID数组”) @RequestParam Integer[] ids)
{

for (int id:ids){

users.remove(id);

}

}

}

User实体类:

 

@JsonInclude(JsonInclude.Include.NON_NULL)

@JsonIgnoreProperties({“handler”, “hibernateLazyInitializer”})

@ApiModel(value = “User”)

public class User {

@ApiModelProperty(value = “ID”)

private String id;

 

@ApiModelProperty(value = “姓名”, required = true)

private String name;

 

@ApiModelProperty(value = “年龄”)

private Integer age;

 

public String getId()
{

return id;

}

 

public void setId(String id)
{

this.id = id;

}

 

public String getName()
{

return name;

}

 

public void setName(String name)
{

this.name = name;

}

 

public Integer getAge()
{

return age;

}

 

public void setAge(Integer age)
{

this.age = age;

}

}

 

<artifactId>springfox-swagger2</artifactId>

1.4 访问控制台

 

按以下步骤配置,项目运行后走访:

<version>2.6.1</version>

1.5 可选配置

在application.properties中参预以下配置,用于安装测试请求的host,暗中同意在swagger
ui上做请求测试时都以以/users/1为路径发送请求。

即使急需转移请求的根路径,就须求配置这些参数:

该Host也是swagger-ui发送测试请求的Host,
平日大家会将将接口文书档案安顿在测试服务器,那样就须求设置Host,

要不请求都是透过localhost发送,请求不到测试服务器的接口。

springfox.documentation.swagger.v2.host
= yourapp.abc.com

配备获取api docs json数据的伸手路径 ,暗中认可为/v2/api-docs:

springfox.documentation.swagger.v2.path = /api

 

</dependency>

2. 浮动静态API文书档案pdf

<dependency>

2.1 Maven 配置

======属性配置=======

<snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>

<asciidoctor.input.directory>${project.basedir}/docs/asciidoc</asciidoctor.input.directory>

<generated.asciidoc.directory>${project.build.directory}/asciidoc</generated.asciidoc.directory>

<asciidoctor.html.output.directory>${project.build.directory}/asciidoc/html</asciidoctor.html.output.directory>

<asciidoctor.pdf.output.directory>${project.build.directory}/asciidoc/pdf</asciidoctor.pdf.output.directory>

 

=====正视配置============

<!–离线文书档案–>

<dependency>

<groupId>org.springframework.restdocs</groupId>

<artifactId>spring-restdocs-mockmvc</artifactId>

<version>1.1.2.RELEASE</version>

<scope>test</scope>

</dependency>

<!–springfox-staticdocs 生成静态文书档案–>

<dependency>

<groupId>io.springfox</groupId>

<artifactId>springfox-staticdocs</artifactId>

<version>2.6.1</version>

</dependency>

<!–swagger2 end–>

 

============插件配置==========

<!–通过Asciidoctor使得asciidoc生成此外的文书档案格式,例如:PDF
或然HTML5–>

<plugin>

<groupId>org.asciidoctor</groupId>

<artifactId>asciidoctor-maven-plugin</artifactId>

<version>1.5.3</version>

<!–生成PDF–>

<dependencies>

<dependency>

<groupId>org.asciidoctor</groupId>

<artifactId>asciidoctorj-pdf</artifactId>

<version>1.5.0-alpha.14</version>

</dependency>

<!– Comment this section to use the default jruby
artifact provided by the plugin –>

<dependency>

<groupId>org.jruby</groupId>

<artifactId>jruby-complete</artifactId>

<version>1.7.21</version>

</dependency>

</dependencies>

 

<!–文书档案生成配置–>

<configuration>

<sourceDirectory>${asciidoctor.input.directory}</sourceDirectory>

<sourceDocumentName>index.adoc</sourceDocumentName>

<attributes>

<doctype>book</doctype>

<toc>left</toc>

<toclevels>3</toclevels>

<numbered></numbered>

<hardbreaks></hardbreaks>

<sectlinks></sectlinks>

<sectanchors></sectanchors>

<generated>${generated.asciidoc.directory}</generated>

</attributes>

</configuration>

<!–因为老是执行只可以处理1个后端,所以对于每个想要的输出类型,都以单身分开执行–>

<executions>

<!–html5–>

<execution>

<id>output-html</id>

<phase>test</phase>

<goals>

<goal>process-asciidoc</goal>

</goals>

<configuration>

<backend>html5</backend>

<outputDirectory>${asciidoctor.html.output.directory}</outputDirectory>

</configuration>

</execution>

<!–pdf–>

<execution>

<id>output-pdf</id>

<phase>test</phase>

<goals>

<goal>process-asciidoc</goal>

</goals>

<configuration>

<backend>pdf</backend>

<outputDirectory>${asciidoctor.pdf.output.directory}</outputDirectory>

</configuration>

</execution>

</executions>

</plugin>

 

 

<groupId>io.springfox</groupId>

2.2 创建index.adoc文件

路径:项目名/docs/asciidoc/index.adoc

内容:

  1. include::{generated}/overview.adoc[]  
  2. include::{generated}/definitions.adoc[]  
  3. include::{generated}/paths.adoc[]  

 

<artifactId>springfox-swagger-ui</artifactId>

2.3 创造生成pdf、html的测试类

package com.inn.demo;

 

import io.github.robwin.markup.builder.MarkupLanguage;

import io.github.robwin.swagger2markup.GroupBy;

import io.github.robwin.swagger2markup.Swagger2MarkupConverter;

import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs;

import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;

import org.springframework.boot.test.context.SpringBootTest;

import org.springframework.http.MediaType;

import org.springframework.test.context.junit4.SpringRunner;

import org.springframework.test.web.servlet.MockMvc;

import org.springframework.test.web.servlet.setup.MockMvcBuilders;

import org.springframework.web.context.WebApplicationContext;

import springfox.documentation.staticdocs.SwaggerResultHandler;

 

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;

import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

 

@AutoConfigureMockMvc

@AutoConfigureRestDocs(outputDir
= “target/generated-snippets”)

@RunWith(SpringRunner.class)

@SpringBootTest

public class Swagger2MarkupTest
{

private String snippetDir = “target/generated-snippets”;

private String outputDir = “target/asciidoc”;

 

@Autowired

private WebApplicationContext context;

 

private MockMvc mockMvc;

 

@Before

public void setUp() {

this.mockMvc = MockMvcBuilders.webAppContextSetup(this.context).build();

}

 

/**

* 生成api html、pdf

* @throws Exception

*/

@Test

public void Test() throws Exception
{

// 得到swagger.json,写入outputDir目录中

mockMvc.perform(get(“/v2/api-docs”).accept(MediaType.APPLICATION_JSON))

.andDo(SwaggerResultHandler.outputDirectory(outputDir).build())

.andExpect(status().isOk())

.andReturn();

//
读取上一步生成的swagger.json转成asciiDoc,写入到outputDir

//
那么些outputDir必须和插件里面<generated></generated>标签配置一致

Swagger2MarkupConverter.from(outputDir + “/swagger.json”)

.withPathsGroupedBy(GroupBy.TAGS)//
按tag排序

.withMarkupLanguage(MarkupLanguage.ASCIIDOC)//
格式

.withExamples(snippetDir)

.build()

.intoFolder(outputDir);// 输出

}

}

 

运作测试类即可生成pdf、html

  1. 生成的PDF和HTML文件:target/asciidoc/html and target/asciidoc/pdf
     

  2. Swagger-UI 汉化


<version>2.6.1</version>

3.1 添加自定义首页和译文

在resourece目录下开创\META-INF\resourece目录,然后创制3个称呼为”swagger-ui.html”
的HTML文件

图片 6

html内容:

<!DOCTYPE html>

<html>

<head>

<meta charset=”UTF-8″>

<title>Swagger UI</title>

<link rel=”icon” type=”image/png” href=”webjars/springfox-swagger-ui/images/favicon-32×32.png” sizes=”32×32″/>

<link rel=”icon” type=”image/png” href=”webjars/springfox-swagger-ui/images/favicon-16×16.png” sizes=”16×16″/>

<link href=’webjars/springfox-swagger-ui/css/typography.css’ media=’screen’ rel=’stylesheet’ type=’text/css’/>

<link href=’webjars/springfox-swagger-ui/css/reset.css’ media=’screen’ rel=’stylesheet’ type=’text/css’/>

<link href=’webjars/springfox-swagger-ui/css/screen.css’ media=’screen’ rel=’stylesheet’ type=’text/css’/>

<link href=’webjars/springfox-swagger-ui/css/reset.css’ media=’print’ rel=’stylesheet’ type=’text/css’/>

<link href=’webjars/springfox-swagger-ui/css/print.css’ media=’print’ rel=’stylesheet’ type=’text/css’/>

<script src=’webjars/springfox-swagger-ui/lib/object-assign-pollyfill.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/jquery-1.8.0.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/jquery.slideto.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/jquery.wiggle.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/jquery.ba-bbq.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/handlebars-4.0.5.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/lodash.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/backbone-min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/swagger-ui.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/highlight.9.1.0.pack.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/highlight.9.1.0.pack_extended.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/jsoneditor.min.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/marked.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lib/swagger-oauth.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/springfox.js’ type=’text/javascript’></script> <!–国际化操作:选取粤语版
–>

<script src=’webjars/springfox-swagger-ui/lang/translator.js’ type=’text/javascript’></script>

<script src=’webjars/springfox-swagger-ui/lang/zh-cn.js’ type=’text/javascript’></script>

</head>

<body class=”swagger-section”>

<div id=’header’>

<div class=”swagger-ui-wrap”>

<a id=”logo” href=”javascript:void(0)”>

<img class=”logo__img” alt=”swagger” height=”30″ width=”30″ src=”webjars/springfox-swagger-ui/images/logo_small.png” />

<span class=”logo__title”>在线API</span>

</a>

<form id=’api_selector’>

<div class=’input’>

<select id=”select_baseUrl” name=”select_baseUrl”></select>

</div>

<div class=’input’>

<input placeholder=”; id=”input_baseUrl” name=”baseUrl” type=”text”/>

</div>

<div id=’auth_container’></div>

<div class=’input’><a id=”explore” class=”header__btn” href=”#” data-sw-translate>Explore</a></div>

</form>

</div>

</div>

<div id=”message-bar” class=”swagger-ui-wrap” data-sw-translate></div>

<div id=”swagger-ui-container” class=”swagger-ui-wrap”></div>

</body>

</html>

马到功成大家走访 http://localhost:8080/swagger-ui.html 看看呈现效果:

图片 7

</dependency>

3.2 更详实的汉化

万一想进一步调整译文,能够在META-INF\resources\webjars\springfox-swagger-ui\lang
目录下添加zh-cn.js文件.

图片 8

 

然后在译文(zh-cn.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”:”服务器重返”

});

居功至伟告成!

<dependency>

<groupId>com.fasterxml.jackson.core</groupId>

<artifactId>jackson-core</artifactId>

<version>2.6.5</version>

</dependency>

<dependency>

<groupId>com.fasterxml.jackson.core</groupId>

<artifactId>jackson-databind</artifactId>

<version>2.6.5</version>

</dependency>

<dependency>

<groupId>com.fasterxml.jackson.core</groupId>

<artifactId>jackson-annotations</artifactId>

<version>2.6.5</version>

</dependency>

2、创建swager配置类

package
com.vk.liyj.config;

import
io.swagger.annotations.ApiOperation;

import
org.springframework.context.annotation.Bean;

import
org.springframework.context.annotation.Configuration;

import
org.springframework.web.servlet.config.annotation.EnableWebMvc;

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;

import
springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

*
类描述:配置swagger2信息

*/

@Configuration //
让Spring来加载该类配置

//@EnableWebMvc //
启用Mvc,非springboot框架需求引入注解@EnableWebMvc

@EnableSwagger2 //
启用Swagger2

public class Swagger2Config
{

@Bean

public Docket
createRestApi() {

return new
Docket(DocumentationType.SWAGGER_2)

.apiInfo(apiInfo())

.select()

//
扫描内定包中的swagger评释

//
.apis(RequestHandlerSelectors.basePackage(“com.vk.liyj”))

//
扫描全部有表明的api,用这种格局更灵敏

.apis(RequestHandlerSelectors

.withMethodAnnotation(ApiOperation.class))

.paths(PathSelectors.any()).build();

}

private ApiInfo apiInfo()
{

return new
ApiInfoBuilder()

.title(“基础平台 RESTful
APIs”)

.description(

“基础平台 RESTful
风格的接口文书档案,内容详见,非常大的裁减了内外端的交流花费,同时确认保证代码与文书档案保持高度一致,不小的缩减维护文书档案的岁月。”)

.termsOfServiceUrl(“”)

.contact(“Xia”).version(“1.0.0”).build();

}

}

透过@Configuration评释,注解它是1个安顿类,@EnableSwagger2开启swagger2。apiINfo()配置部分中坚的消息。apis()钦定扫描的包会生成文书档案。

3、编写swagger注解

package com.vk.liyj.model;

import
io.swagger.annotations.ApiModel;

import
io.swagger.annotations.ApiModelProperty;

import java.util.Date;

import
org.springframework.format.annotation.DateTimeFormat;

import
com.fasterxml.jackson.annotation.JsonFormat;

import
com.fasterxml.jackson.annotation.JsonIgnoreProperties;

import
com.fasterxml.jackson.annotation.JsonInclude;

/**

* 职员新闻表 注脚:@ApiModel 和
@ApiModelProperty
用于在通过对象收取参数时在API文档中显得字段的证实

* 注明:@DateTimeFormat 和 @JsonFormat
用于在吸收和重临日期格式时将其格式化 实体类对应的数据表为:
user_info

*

发表评论

电子邮件地址不会被公开。 必填项已用*标注