前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >原 JAVA懒开发:整合swagger对测

原 JAVA懒开发:整合swagger对测

作者头像
kinbug [进阶者]
发布2018-06-13 15:21:23
1.3K0
发布2018-06-13 15:21:23
举报
文章被收录于专栏:IT进修之路IT进修之路

swagger

什么是swagger

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

添加Swagger2依赖

代码语言:javascript
复制
<!-- 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配置类

代码语言:javascript
复制
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的整合就已经完成了,只需要在接口类和实体类中加注解就好了

接口类中使用

代码语言:javascript
复制
@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;
	}
}

对象参数和返回对象使用

代码语言:javascript
复制
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 多个请求参数

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • swagger
    • 什么是swagger
      • 添加Swagger2依赖
        • 创建Swagger2配置类
          • 接口类中使用
            • 对象参数和返回对象使用
              • 显示结果
                • 写生产文档的注解
                领券
                问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档