Swagger2在SpringBoot环境下的应用

集成步骤

第四章 springboot + swagger,springbootswagger

注:本文参考自

 

swagger用于定义API文档。

好处:

  • 前后端分离开发
  • API文档非常明确
  • 测试的时候不需要再使用URL输入浏览器的方式来访问Controller
  • 传统的输入URL的测试方式对于post请求的传参比较麻烦(当然,可以使用postman这样的浏览器插件)
  • spring-boot与swagger的集成简单的一逼

1、项目结构

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

2、pom.xml

引入了两个jar。

yzc579亚洲城官网 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

yzc579亚洲城官网 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

yzc579亚洲城官网 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 UserService
userService; 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.USER_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:抛出异常的类

以上这些就是最常用的几个注解了。

具体其他的注解,查看:

 

测试:

启动服务,浏览器输入””

yzc579亚洲城官网 4

最上边一个红框:@Api

GET红框:method=RequestMethod.GET

右边红框:@ApiOperation

parameter红框:@ApiImplicitParams系列注解

response messages红框:@ApiResponses系列注解

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

yzc579亚洲城官网 5

 

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

1. 集成Swagger

1、在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-RS的环境,只能使用 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发送,请求不到测试服务器的接口。

yzc579亚洲城官网,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>

<!–因为每次执行只能处理一个后端,所以对于每个想要的输出类型,都是独立分开执行–>

<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目录,然后创建一个名称为”swagger-ui.html”
的HTML文件

yzc579亚洲城官网 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 看看显示效果:

yzc579亚洲城官网 7

</dependency>

3.2 更详细的汉化

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

yzc579亚洲城官网 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注解,表明它是一个配置类,@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

*

*

*/

@JsonInclude(JsonInclude.Include.NON_NULL)

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

@ApiModel(value = “UserInfo”)

public class UserInfo {

@ApiModelProperty(value = “ID”)

private Integer id;

@ApiModelProperty(value = “用户登录账号”,
required = true)

private String userNo;

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

private String userName;

@ApiModelProperty(value =
“姓名拼音”)

private String spellName;

@ApiModelProperty(value = “密码”, required
= true)

private String password;

@ApiModelProperty(value = “手机号”,
required = true)

private String userPhone;

@ApiModelProperty(value = “性别”)

private Integer userGender;

@ApiModelProperty(value =
“记录创建时间”)

@DateTimeFormat(pattern = “yyyy-MM-dd
HH:mm:ss”)

private Date createTime;

@ApiModelProperty(value =
“记录修改时间”)

@DateTimeFormat(pattern = “yyyy-MM-dd
HH:mm:ss”)

private Date updateTime;

@JsonFormat(locale = “zh”, timezone =
“GMT+8”, pattern = “yyyy-MM-dd HH:mm:ss”)

public Date getCreateTime() {

return createTime;

}

@JsonFormat(locale = “zh”, timezone =
“GMT+8”, pattern = “yyyy-MM-dd HH:mm:ss”)

public Date getUpdateTime() {

return updateTime;

}

}

4、控制器类

package
com.vk.liyj.controller;

import
io.swagger.annotations.Api;

import
io.swagger.annotations.ApiImplicitParam;

import
io.swagger.annotations.ApiImplicitParams;

import
io.swagger.annotations.ApiOperation;

import
java.util.List;

import
javax.servlet.http.HttpServletRequest;

import
javax.servlet.http.HttpServletResponse;

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

import
org.springframework.stereotype.Controller;

import
org.springframework.web.bind.annotation.RequestMapping;

import
org.springframework.web.bind.annotation.RequestMethod;

import
org.springframework.web.bind.annotation.RequestParam;

import
com.vk.liyj.model.UserInfo;

import
com.vk.liyj.service.UserInfoService;

/**

* 类描述:人员基本信息

*/

@Controller

@RequestMapping(value =
“/userInfo”)

@Api(value = “UserInfo”,
description = “人员基本信息 “)

public class
UserInfoController {

@Autowired

UserInfoService
service;

@RequestMapping(value =
“/selectAllUsers”, method = RequestMethod.GET)

@ApiOperation(value =
“查询所有的人员信息”, notes = “查询所有的人员信息”)

public String
selectAllUsers(HttpServletRequest request, HttpServletResponse response)
{

List<UserInfo>
userList = service.selectAllUsers();

request.setAttribute(“userList”,
userList);

return
“userList.jsp”;

}

@RequestMapping(value =
“selectById”, method = RequestMethod.GET)

@ApiOperation(value =
“根据用户id查询用户详细信息”, notes =
“根据用户id查询用户详细信息”)

@ApiImplicitParams({

@ApiImplicitParam(name =
“type”, value = “类型(修改:update;默认为查看)”, required = false,
paramType = “query”),

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

})

public String
selectById(HttpServletRequest request, HttpServletResponse
response,

@RequestParam(value = “id”)
Integer id, @RequestParam(value = “type”) String type) {

UserInfo user =
service.selectByPrimaryKey(id);

request.setAttribute(“user”,
user);

if(“update”.equals(type))
{

return
“userUpdate.jsp”;

} else {

return
“userView.jsp”;

}

}

@RequestMapping(value =
“deleteById”, method = RequestMethod.GET)

@ApiOperation(value =
“根据用户id删除用户信息”, notes = “根据用户id删除用户信息”)

@ApiImplicitParams({

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

})

public String
deleteById(HttpServletRequest request, HttpServletResponse response,
@RequestParam(value = “id”) Integer id) {

int count = 0;

try {

count =
service.deleteByPrimaryKey(id);

if(count <=0 ) {

return “error.jsp”;

} else {

request.getRequestDispatcher(“selectAllUsers”).forward(request,
response);

return
“userList.jsp”;

}

} catch (Exception e)
{

e.getMessage();

e.printStackTrace();

return “error.jsp”;

}

}

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

@ApiOperation(value =
“添加用户信息”, notes = “添加用户信息”)

public String
add(HttpServletRequest request, HttpServletResponse response, UserInfo
user) {

int count = 0;

try {

count =
service.insertSelective(user);

if(count <=0 ) {

return “error.jsp”;

} else {

//POST请求的方法不能直接转发到GET请求的方法,需要重定向

response.sendRedirect(“selectAllUsers”);

return
“userList.jsp”;

}

} catch (Exception e)
{

e.getMessage();

e.printStackTrace();

return “error.jsp”;

}

}

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

@ApiOperation(value =
“根据用户id修改用户信息”, notes = “根据用户id修改用户信息”)

public String
update(HttpServletRequest request, HttpServletResponse response,
UserInfo user) {

int count = 0;

try {

count =
service.updateByPrimaryKeySelective(user);

if(count <=0 ) {

return “error.jsp”;

} else {

//POST请求的方法不能直接转发到GET请求的方法,需要重定向

response.sendRedirect(“selectAllUsers”);

return
“userList.jsp”;

}

} catch (Exception e)
{

e.getMessage();

e.printStackTrace();

return “error.jsp”;

}

}

}

swagger通过注解表明该接口会生成文档,包括接口名、请求方法、参数、返回信息的等等。

  • @Api:修饰整个类,描述Controller的作用
  • @ApiOperation:描述一个类的一个方法,或者说一个接口
  • @ApiParam:单个参数描述
  • @ApiModel:用对象来接收参数
  • @ApiProperty:用对象接收参数时,描述对象的一个字段
  • @ApiResponse:HTTP响应其中1个描述
  • @ApiResponses:HTTP响应整体描述
  • @ApiIgnore:使用该注解忽略这个API
  • @ApiError :发生错误返回的信息
  • @ApiParamImplicitL:一个请求参数
  • @ApiParamsImplicit 多个请求参数

5、启动程序访问
http://localhost:8080/spring-mvc/swagger-ui.html

6、替换默认的UI

<dependency>

<groupId>com.github.xiaoymin</groupId>

<artifactId>swagger-bootstrap-ui</artifactId>

<version>1.6</version>

</dependency>

<!–
使用swagger-bootstrap-ui替换默认的UI

<dependency>

<groupId>io.springfox</groupId>

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

<version>2.6.1</version>

</dependency>

–>

替换后访问路径:http://localhost:8080/web/doc.html

参考资料

http://blog.csdn.net/songanling/article/details/71079304

https://gitee.com/xiaoym/swagger-bootstrap-ui

源码下载地址:

Author

发表评论

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