首页 > 编程语言 > 详细

springboot配置swagger2

时间：2017-07-24 17:37:01 阅读：227 评论：0 收藏：0 [点我收藏+]

标签：rod 配置 method selector ble plain document oar 手机号

、在pom.xml里添加jar包：

[java] view plain copy

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox.version}</version>
</dependency>

在pom.xml里的properties里添加版本

[java] view plain copy

<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
<springfox.version>2.5.0</springfox.version>
</properties>

2、在com/demo下创建swagger文件夹，创建SwaggerConfig文件

[java] view plain copy

package com.demo.swagger;
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;
/**
* Created by huguoju on 2016/12/29.
*/
@Configuration
@EnableSwagger2
public class SwaggerConfig {
/**
* 可以定义多个组，比如本类中定义把test和demo区分开了（访问页面就可以看到效果了）
*
*/
@Bean
public Docket testApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("com.demo"))
.paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Spring Boot中使用Swagger2构建RESTful APIs")
.description("spring Boot 中构建RESTful API")
.termsOfServiceUrl("")
.contact("huguoju")
.version("1.0")
.build();
}
}

以上就完成了，在页面访问localhost:8080/swagger-ui.html,就看见了，下面主要说说怎么用

1、在com/dem/controller下创建TestController，

[java] view plain copy

package com.demo.controller;
import com.demo.model.User;
import com.demo.service.TestService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.MediaType;
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;
/**
* Created by huguoju on 2016/12/28.
*/
@Controller
@RequestMapping("test")
@Api(value = "测试类",tags = "测试接口")
public class TestController {
@Autowired
private TestService testService;
@RequestMapping(value = "testData",produces = MediaType.APPLICATION_JSON_UTF8_VALUE,method = {RequestMethod.POST,RequestMethod.GET})
@ApiOperation("测试读写分离")
public String testDateSource(
@ApiParam(name = "userCode",value = "用户id",required = true)
@RequestParam Integer userCode){
User user=testService.selectByUserCode(userCode);
Integer integer=testService.insertUser(user);
return "oo";
}
}

以上就是controller里主要用到的@Api, @ApiOperation ,@ApiParam

在model里使用@ApiModelProperty("")

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import org.springframework.stereotype.Component;
import java.util.Date;
@Data
public class User {
@ApiModelProperty("用户id")
private Integer userCode;
@ApiModelProperty("用户类型")
private String userType;
@ApiModelProperty("用户名称")
private String userName;
@ApiModelProperty("用户手机号")
private String mobileNumber;
}

springboot配置swagger2

标签：rod 配置 method selector ble plain document oar 手机号

原文地址：http://www.cnblogs.com/xuyatao/p/7229712.html

踩

(0)

赞

(0)

举报

评论一句话评论（0）

分享档案

更多>

2021年07月29日 (22)
2021年07月28日 (40)
2021年07月27日 (32)
2021年07月26日 (79)
2021年07月23日 (29)
2021年07月22日 (30)
2021年07月21日 (42)
2021年07月20日 (16)
2021年07月19日 (90)
2021年07月16日 (35)

周排行

更多

友情链接

兰亭集智国之画百度统计站长统计阿里云 chrome插件新版天听网

关于我们 - 联系我们 - 留言反馈

© 2014 mamicode.com 版权所有联系我们:gaon5@hotmail.com

迷上了代码！