原 JAVA懒开发:整合swagger对测

swagger

什么是swagger

       swagger中文“拽”的意思。它是一个功能强大的api框架,它的集成非常简单,不仅提供了在线文档的查阅,而且还提供了在线文档的测试。另外swagger很容易构建restful风格的api,简单优雅帅气,正如它的名字。

添加Swagger2依赖

<!-- swagger2与swagger-ui同一版本  -->
<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配置类

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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
 * Swagger核心配置文件
 * ========================
 * @author  BianP 
 * Date:2018/1/30
 * Time:23:07
 * ========================
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
	
	public static String CONTROLLER_URL="com.lazy.develop.controller";  //Swagger扫描的接口路径
	public static String SWAGGER_TITLE="JAVA懒开发-SWAGGER的使用"; 	    //Swagger接口文档标题
	public static String SWAGGER_DESCRIPTION="swagger打造不一样的API";   //Swagger接口文档描述
	public static String SWAGGER_VERSION="1.0";                         //Swagger接口文档版本
	public static String SWAGGER_URL="http://127.0.0.1:8080";           //Swagger项目服务的URL
	
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(CONTROLLER_URL))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(SWAGGER_TITLE)
                .description(SWAGGER_DESCRIPTION)
                .termsOfServiceUrl(SWAGGER_URL)
                .version(SWAGGER_VERSION)
                .build();
    }
}

这个时候Swagger2的整合就已经完成了,只需要在接口类和实体类中加注解就好了

接口类中使用

@Api(description = "用户模块",value="用户。。" )
@RestController
@RequestMapping("/user")
public class UserController {

	Logger logger = Logger.getLogger(UserController.class);
	@Autowired
	public UserService userServiceImpl;
	
	/**
	 * @explain 获取用户
	 * @param   用户ID:id
	 * @return  User
	 * @author  BianP
	 */
	@ApiIgnore//使用该注解忽略这个API
	@RequestMapping(value="/getUserRolePage", method = RequestMethod.GET)
	public List<Record> getUserRolePage(HttpServletRequest request){
		Record record=new Record(request);
		//record.put("name", "name"); //和普通的map使用一样
		//String name=record.getString("name");
		//Integer id=record.getInteger("id");
		//Long id2=record.getLong("id");
		//Object obj=record.get("user"); //目前就写了这几个,大家可以根据自己的需求改哈
		List<Record> user = userServiceImpl.getUserRolePage(record);
		return user;
	}
	
	/**
	 * @explain 获取所有用户   <swagger POST请求>
	 * @param   对象参数:swaggerTest
	 * @return  List<User>
	 * @author  BianP
	 */
	@ApiOperation(value = "获取所有用户", notes = "查询所有用户")
	@RequestMapping(value="/getUserAll_POST", method = RequestMethod.POST)
	public List<User> getUserAll_POST(SwaggerTest swaggerTest){
		List<User> user = userServiceImpl.getUserAll();
		return user;
	}
	
	/**
	 * @explain 获取所有用户 <swagger get请求>
	 * @param   对象参数:swaggerTest
	 * @return  List<User>
	 * @author  BianP
	 */
	@ApiOperation(value = "获取所有用户", notes = "查询所有用户")
	@RequestMapping(value="/getUserAll_GET", method = RequestMethod.GET)
	public List<User> getUserAll_GET(SwaggerTest swaggerTest){
		List<User> user = userServiceImpl.getUserAll();
		return user;
	}
	
	
	/**
	 * @explain 获取所有用户 <swagger 链接参数与请求Body参数>
	 * @param   用户ID:id,对象参数:swaggerTest
	 * @return  List<User>
	 * @author  BianP
	 */
	@ApiOperation(value = "获取所有用户", notes = "查询所有用户")
	@ApiImplicitParams({
        @ApiImplicitParam(name = "ids", value = "用户ID", required = true, dataType = "Long",paramType = "path"),
        @ApiImplicitParam(name = "swaggerTest", value = "swagger测试参数对象", required = true, dataType = "SwaggerTest")
	})
	@RequestMapping(value="/getUserAll_POST/{ids}", method = RequestMethod.POST)
	public List<User> getUserAll_POST2(@PathVariable Long ids, @RequestBody SwaggerTest swaggerTest){
		List<User> user = userServiceImpl.getUserAll();
		return user;
	}
}

对象参数和返回对象使用

import java.util.Date;
import org.springframework.format.annotation.DateTimeFormat;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

@Data
public class SwaggerTest {
	
	@ApiModelProperty(name = "id" , value = "用户ID")
	private Long id;
	
	@ApiModelProperty(name = "loginName" , value = "用户登录名")
	private String loginName;
	
	@ApiModelProperty(name = "password" , value = "用户密码")
	private String password;
	
	@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
	@ApiModelProperty(name = "createTime" , value = "用户创建时间")
	private Date createTime;

}

到这就整合玩了................................................

输入http://127.0.0.1:8080/swagger-ui.html

显示结果

写生产文档的注解

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

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏数据和云

分区表可以使用不同BLOCK_SIZE的表空间吗?

编辑手记:Oracle数据库中有两种类型的块,标准块和非标准块。非标准块的引入给数据库的管理带来了方便,但在使用的时候也有一些限制。本文将会详细解读块大小对于分...

32911
来自专栏小尘哥的专栏

美化一下你的API文档吧(springboot集成swagger及遇到的问题)

微服务的流行提供了诸多的方便,随着也带来了N多的API,而swagger2正是一个对API管理的很好的“工具”,本文主要介绍springboot对swagger...

1553
来自专栏dalaoyang

SpringBoot使用Swagger2实现Restful API

很多时候,我们需要创建一个接口项目用来数据调转,其中不包含任何业务逻辑,比如我们公司。这时我们就需要实现一个具有Restful API的接口项目。 本文介绍sp...

4198
来自专栏xingoo, 一个梦想做发明家的程序员

Elasticsearch+Logstash+Kibana教程

参考资料 累了就听会歌吧! Elasticsearch中文参考文档 Elasticsearch官方文档 Elasticsearch 其他——那些年遇到的坑 El...

4467
来自专栏Albert陈凯

2018-11-18 swagger2 自动生成API

作者:小莫 链接:https://www.zhihu.com/question/28119576/answer/134580038 来源:知乎 著作权归作...

1043
来自专栏battcn

一起来学SpringBoot | 第十一篇:集成Swagger在线调试

随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、前后端分离的形态,而且前端和后端在各自的技术道路上越走越远。

963
来自专栏Ryan Miao

使用swagger作为restful api的doc文档生成

初衷 记得以前写接口,写完后会整理一份API接口文档,而文档的格式如果没有具体要求的话,最终展示的文档则完全决定于开发者的心情。也许多点,也许少点。甚至,接口总...

48310
来自专栏刘君君

Spring Boot中使用Swagger2构建强大的RESTful API文档

3257
来自专栏菩提树下的杨过

mac 10.9.4下配置apache

启动后,访问 http://localhost/ 应该能看到"It works!"的初始页面,如果对初始页面的内容感到好奇,可以打开"/etc/apache2/...

682
来自专栏专注于主流技术和业务

REST API文档工具Swagger2,以及与SpringBoot的集成

swagger是一个API框架,号称世界上最流行的API工具。它提供了API管理的全套解决方案,比如API在线编辑器,APIUI展示界面,代码生成器等诸多功能。...

862

扫码关注云+社区