Spring boot 集成 Swagger

最新推荐文章于 2022-03-20 20:17:21 发布
最新推荐文章于 2022-03-20 20:17:21 发布
阅读量1k 收藏
点赞数 1
文章标签： Spring boot Swagger
如果我们不尊重权威,源码看起来也没有什么借鉴意义,如果我们完全的信服权威,那么源码中未发现的bug就天然的被忽略了
本文链接：https://blog.csdn.net/bestcxx/article/details/76607317
版权

 

·Swagger 入口地址 

http://localhost:8081/项目名/swagger-ui.html

 

·Maven 依赖

 

<!-- Swagger2 -->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.7.0</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.7.0</version>
		</dependency>

 

·增加配置类

 

 

package com.bestcxx.stu.springbootsecuritydb.swagger.config;

import java.util.ArrayList;
import java.util.List;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.async.DeferredResult;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2//启用 Swagger2 测试框架
public class Swagger2Configuration {
	@Bean
	public Docket buildDocket() {
		ParameterBuilder parameterBuilder = new ParameterBuilder();
		List<Parameter> paramList = new ArrayList<Parameter>();
		parameterBuilder.name("auth_token").description("Authentication Token")//auth_token 被放置在header
		.modelRef(new ModelRef("string")).parameterType("header").required(false).build();//在测试框架，
		paramList.add(parameterBuilder.build());

		return new Docket(DocumentationType.SWAGGER_2).apiInfo(buildApiInfo()).groupName("bestcxx")
				.genericModelSubstitutes(DeferredResult.class).useDefaultResponseMessages(false)
				.globalOperationParameters(paramList).forCodeGeneration(true).select()
				.apis(RequestHandlerSelectors.basePackage("com.bestcxx.stu.springbootsecuritydb")).paths(PathSelectors.any()).build();
	}

	private ApiInfo buildApiInfo() {
		return new ApiInfoBuilder().title("http://www.bestcxx.cn").contact(new Contact("Bestcxx", "http://www.bestcxx.cn ", "1"))
				.version("1.0").build();
	}
}

 

 

 

第一种是加到方法中的

	@ApiOperation(value = "根据不同条件查询订单列表", notes = "根据不同条件查询订单列表")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "page", value = "查询第几页", required = true, paramType = "query",dataType="int"),
        @ApiImplicitParam(name = "memberInfo", value = "memberInfoId 渠道商Id", required = true, paramType = "query",dataType="int"),
        @ApiImplicitParam(name = "enterpriseInfoId", value = "enterpriseInfoId 渠道商所属企业Id", required = true, paramType = "query",dataType="int"),
        @ApiImplicitParam(name = "orderStatus", value = "orderStatus 订单状态", required = false, paramType = "query",dataType="string"),
        @ApiImplicitParam(name = "paymentStatus", value = "paymentStatus 订单支付状态", required = false, paramType = "query",dataType="int"),
        @ApiImplicitParam(name = "multipleStr", value = "multipleStr 订单号/商品名称", required = false, paramType = "query",dataType="string"),
    })
	public ResponseEntity<Object> getChannelOrderList(@RequestParam("page") int page,
			@RequestParam("memberInfo") String memberInfo, @RequestParam("enterpriseInfoId") String enterpriseInfoId,
			@RequestParam("orderStatus") String orderStatus, @RequestParam("paymentStatus") String paymentStatus,
			@RequestParam("multipleStr") String multipleStr) {


第二种是加到实体中的-@Data可以免去get/set方法

@Data
@ApiModel
public class AddNewOrderRequestEntity {
	@ApiModelProperty(value="orderProductList 商品列表 ",required=true,dataType="List")
	private List<OrderProduct> orderProductList;
	
	@ApiModelProperty(value="deliverAddressId 收货人地址id",required=true,dataType="int")
	private Integer deliverAddressId;
	
	@ApiModelProperty(value="timeSlot 配送时段: 0-全天,1-上午,2-下午,3-晚上",required=true,dataType="int",allowableValues="0,1,2,3")
	private Byte timeSlot;
	@ApiModelProperty(value="paymentMode 1-余额支付,2-货到付款(现金),3-货到付款(POS),4-货到付款(支票),5-赊销,"
			+ "9-转账,10-订单礼品赠送,11-预付款,12-周期付款,13-微信支付,14-支付宝支付",
			required=true,dataType="int",allowableValues="1,2,3,4,5,9,10,11,12,14")
	private Integer paymentMode;
	
	@ApiModelProperty(value="orderRemark 订单备注",required=false,dataType="string")
	private String orderRemark;
	
	@ApiModelProperty(value="deliverTime 配送时间 yyyy-MM-dd",required=true,dataType="date")
	private String deliverTime;
	
	@ApiModelProperty(value="productAccount 商品金额",required=true,dataType="float")
	private Float productAccount;
	
	@ApiModelProperty(value="deliverAccount 配送金额",required=true,dataType="float")
	private Float deliverAccount; 
	
	@ApiModelProperty(value="paymentAccount 应付金额",required=true,dataType="float")
	private Float paymentAccount;
	
	@ApiModelProperty(value="totalAccount 订单总金额",required=true,dataType="float")
	private Float totalAccount;
	
	@ApiModelProperty(value="balanceAccount 使用余额金额",required=true,dataType="float")
	private Float balanceAccount;
}

 

第三种是加到 controller上的

 

@Api(value="用户登陆",tags="用户登陆")
public class AuthenticationController extends BaseController<AuthenticationResponse> {

第四种是加到方法中

@ApiOperation("获取注册验证码接口")
方法（
@ModelAttribute("produceBatchInfoDTO")）
或者
@ApiOperation("获取注册验证码接口")
方法（
@RequestBody）

最佳实践

·类上+方法上+实体中

@RestController
@RequestMapping("/order")
@Api(value="**接口", description="**相关信息")
public class OrderController extends BaseController {
/**@RequestBody 不是必要的,在Swagger的展示上会有所不同,看前端调用方式了*/
 @PostMapping(value = "/orderquery")
    @ApiOperation(value = "**查询接口")
    public OrderQueryQueryResponseVO<OrderQueryResponseVO> getTradeList(@RequestBody OrderQueryRequestVO requestVO,
                                       HttpServletRequest request, HttpServletResponse response) {
	
@ApiModel("**查询请求实体")
public class OrderQueryRequestVO extends BaseRequestVO{
	
	@ApiModelProperty(value="商户名称")
	/**商户名称-模糊查询 
	 * */
	private String merchantName;

    //··· 下面略

 

如果嵌套实体,记住使用范型

关于Swagger @ApiModel 返回内容注释不显示问题:https://blog.csdn.net/qq_32917699/article/details/81486060
让外部感知到内部的实体类型,该实体内部增加 Swagger 注释

 

 

------------------

以下部分为转载：

本文转载自：http://www.cnblogs.com/cocoat/p/6494849.html

1、引入swagger需要的java类库

 

复制代码

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.0</version>
        </dependency>

        <dependency>
            <groupId>com.fasterxml</groupId>
            <artifactId>classmate</artifactId>
            <version>1.3.1</version>
        </dependency>

复制代码

 

2、引入SwaggerConfig.java类，并配置

 

复制代码

package com.coracle.positec.xweb.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.context.request.async.DeferredResult;
import springfox.documentation.builders.ApiInfoBuilder;
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;

import static com.google.common.base.Predicates.or;
import static springfox.documentation.builders.PathSelectors.regex;

/**
 * SwaggerConfig
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /**
     * 可以定义多个组，比如本类中定义把test和demo区分开了 （访问页面就可以看到效果了）
     *
     */
    @Bean
    public Docket testApi() {
        return new Docket(DocumentationType.SWAGGER_2)

                .groupName("api_bsd")
                .genericModelSubstitutes(DeferredResult.class)
                .useDefaultResponseMessages(false)
                .forCodeGeneration(false)
                .pathMapping("/")
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.coracle.positec.xweb.controller")).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("保时得项目RESTful API")
                .description("保时得项目中构建RESTful API")
                .termsOfServiceUrl("")
                .contact("huangbaidong")
                .version("1.0")
                .build();
    }
}

复制代码

 

3、配置Controller接口注解

swagger类注释
@Api(value = "订单类",tags = "订单类测试接口")

swagger接口注释
@ApiOperation("订单列表")

swagger参数注释
@ApiParam("订单ID")

4、配置实体注解

swagger实体类注释

@ApiModel("订单实体类")

swagger实体类中隐藏属性

@ApiModelProperty(hidden = true)

 

swagger实体属性备注

@ApiModelProperty("订单编号")
 
 
增加一个写的更全面的
转自：http://www.jianshu.com/p/67c9b84226cd
 
 

一、简介

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新 。接口的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

我们的RESTful API就有可能要面对多个开发人员或多个开发团队：IOS开发、Android开发、Web开发等。为了减少与其他团队平时开发期间的频繁沟通成本，传统做法我们会创建一份RESTful API文档来记录所有接口细节，然而这样的做法有以下几个问题：

  1. 由于接口众多，并且细节复杂（需要考虑不同的HTTP请求类型、HTTP头部信息、HTTP请求内容等），高质量地创建这份文档本身就是件非常吃力的事，下游的抱怨声不绝于耳；
  2. 随着时间推移，不断修改接口实现的时候都必须同步修改接口文档，而文档与代码又处于两个不同的媒介，除非有严格的管理机制，不然很容易导致不一致现象；

而swagger完美的解决了上面的几个问题，并与Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量，同时说明内容又整合入实现代码中，让维护文档和修改代码整合为一体，可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能 来调试每个RESTful API。

二、添加Swagger2依赖

<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.6.1</version>
</dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger-ui</artifactId>
     <version>2.6.1</version>
</dependency>
<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>

三、创建Swagger2配置类


package com.xia.common.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import io.swagger.annotations.ApiOperation;
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信息 
 * 创建人：XiaChengwei 
 * 创建时间：2017年7月28日 上午10:03:29
 * @version 1.0
 */
@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.xia.controller"))
                //扫描所有有注解的api，用这种方式更灵活
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("基础平台 RESTful APIs")
                .description("基础平台 RESTful 风格的接口文档，内容详细，极大的减少了前后端的沟通成本，同时确保代码与文档保持高度一致，极大的减少维护文档的时间。")
                .termsOfServiceUrl("http://xiachengwei5.coding.me")
                .contact("Xia")
                .version("1.0.0")
                .build();
    }
}

四、编写swagger注解

实体类：


package com.xia.model;

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;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
 * 人员信息表
 * 注解：@ApiModel 和 @ApiModelProperty 用于在通过对象接收参数时在API文档中显示字段的说明
 * 注解：@DateTimeFormat 和 @JsonFormat 用于在接收和返回日期格式时将其格式化
 * 实体类对应的数据表为：  user_info
 * @author XiaChengwei 
 * @date:  2017-07-14 16:45:29
 */
@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;
    
    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }
    
    public String getUserNo() {
        return userNo;
    }

    public void setUserNo(String userNo) {
        this.userNo = userNo == null ? null : userNo.trim();
    }
    
    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName == null ? null : userName.trim();
    }
    
    public String getSpellName() {
        return spellName;
    }

    public void setSpellName(String spellName) {
        this.spellName = spellName;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password == null ? null : password.trim();
    }
   
    public String getUserPhone() {
        return userPhone;
    }

    public void setUserPhone(String userPhone) {
        this.userPhone = userPhone == null ? null : userPhone.trim();
    }
    
    public Integer getUserGender() {
        return userGender;
    }

    public void setUserGender(Integer userGender) {
        this.userGender = userGender;
    }
  
    @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
    public Date getCreateTime() {
        return createTime;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    @JsonFormat(locale = "zh", timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
    public Date getUpdateTime() {
        return updateTime;
    }

    public void setUpdateTime(Date updateTime) {
        this.updateTime = updateTime;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append(getClass().getSimpleName());
        sb.append(" [");
        sb.append("Hash = ").append(hashCode());
        sb.append(", id=").append(id);
        sb.append(", userNo=").append(userNo);
        sb.append(", userName=").append(userName);
        sb.append(", spellName=").append(spellName);
        sb.append(", password=").append(password);
        sb.append(", userPhone=").append(userPhone);
        sb.append(", userGender=").append(userGender);
        sb.append(", createTime=").append(createTime);
        sb.append(", updateTime=").append(updateTime);
        sb.append("]");
        return sb.toString();
    }
}

控制类：


package com.infore.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import com.github.pagehelper.PageHelper;
import com.github.pagehelper.PageInfo;
import com.infore.common.pinyin.PinyinUtils;
import com.infore.common.util.ControllerUtil;
import com.infore.model.ResponseDto;
import com.infore.model.UserInfo;
import com.infore.model.dto.UserInfoDto;
import com.infore.service.UserInfoService;
import gbap.log.Logger;
import gbap.log.LoggerFactory;
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.annotation.Resource;
import javax.ws.rs.core.MediaType;

/**
 * 人员信息控制类
 * @author XiaChengwei 
 * @date:  2017-07-14 16:45:29
 */
@RestController
@RequestMapping(value = "/userInfo", produces = MediaType.APPLICATION_JSON)
@Api(value = "用户信息", description = "用户信息", produces = MediaType.APPLICATION_JSON)
public class UserInfoController {
    private Logger logger = LoggerFactory.getLogger(getClass());
    
    @Resource
    UserInfoService service;
    
    @ResponseBody
    @RequestMapping(value = "/selectAllUsers", method = RequestMethod.GET)
    @ApiOperation(value = "查询所有的人员信息并分页展示", notes = "查询所有的人员信息并分页展示")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "page",value = "跳转到的页数", required = true, paramType = "query"),
        @ApiImplicitParam(name = "size",value = "每页展示的记录数", required = true, paramType = "query")
    })
    public ResponseDto selectAllUsers(Integer page, Integer size) {
        page = page == null || page <= 0 ? 1 : page;
        size = size == null || size <= 5 ? 5 : size;
        PageHelper.startPage(page, size);//PageHelper只对紧跟着的第一个SQL语句起作用
        List<UserInfo> userInfoList = service.selectAllUsers();
        PageInfo pageInfo = new PageInfo(userInfoList);
        return ControllerUtil.returnDto(true, "成功", pageInfo);
    }
    
    @ResponseBody
    @RequestMapping(value = "/selectContacts", method = RequestMethod.GET)
    @ApiOperation(value = "查询通讯录人员信息", notes = "查询通讯录人员信息")
    public ResponseDto selectContacts() {
        List<UserInfo> list = service.selectContacts();
        return ControllerUtil.returnDto(true, "成功", list);
    }
    
    @ResponseBody
    @RequestMapping(value = "selectByUserNo", method = RequestMethod.GET)
    @ApiOperation(value = "新增人员前先检测用户名是否可用", notes = "新增人员前先检测用户名是否可用")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "user_no", value = "用户输入的用户名", required = true, paramType = "query")
    })
    public ResponseDto selectByUserNo(String user_no) {
        UserInfo userInfo = service.selectByUserNo(user_no);
        if(null == userInfo || "".equals(userInfo.getUserNo())) {
            return ControllerUtil.returnDto(true, "此用户名可用", null);
        }else {
            return ControllerUtil.returnDto(false, "此用户名不可用", null);
        }
    }

    @ResponseBody
    @RequestMapping(value = "insertSelective", method = RequestMethod.POST)
    @ApiOperation(value = "新增人员", notes = "新增人员")
    public ResponseDto insertSelective(UserInfoDto userInfoDto) {
        int count = 0;
        PinyinUtils pinyin = new PinyinUtils();
        try {
            //新增人员之前先检查用户名是否可用
            UserInfo userInfo = service.selectByUserNo(userInfoDto.getUserNo());
            if(null != userInfo && !"".equals(userInfo.getUserNo())) {
                return ControllerUtil.returnDto(false, "此用户名不可用", null);
            }
            
            if(null != userInfoDto.getUserName() && !"".equals(userInfoDto.getUserName())) {
                //获取姓名拼音并存在对象中
                userInfoDto.setSpellName(pinyin.getPingYin(userInfoDto.getUserName()));
            }else {
                return ControllerUtil.returnDto(false, "请输入姓名", count);
            }
            
            count = service.insertSelective(userInfoDto);
            if(count <= 0) {
                return ControllerUtil.returnDto(false, "失败", count);
            }else {
                return ControllerUtil.returnDto(true, "成功", count);
            }
        } catch (Exception e) {
            logger.error("userInfo--insertSelective:系统异常");
            return ControllerUtil.returnDto(false, "系统异常", count);
        }
    }
    
    @ResponseBody
    @RequestMapping(value = "updateByPrimaryKeySelective", method = RequestMethod.POST)
    @ApiOperation(value = "根据id修改人员信息", notes = "根据id修改人员信息")
    public ResponseDto updateByPrimaryKeySelective(UserInfoDto userInfoDto) {
        int count = 0;
        try {
            count = service.updateByPrimaryKeySelective(userInfoDto);
            if(count <= 0) {
                return ControllerUtil.returnDto(false, "失败", count);
            }else {
                return ControllerUtil.returnDto(true, "成功", count);
            }
        } catch (Exception e) {
            logger.error("userInfo--updateByPrimaryKeySelective:系统异常");
            return ControllerUtil.returnDto(false, "系统异常", count);
        }
    }
    
    @ResponseBody
    @RequestMapping(value = "modifyPwdById", method = RequestMethod.GET)
    @ApiOperation(value = "修改密码", notes = "修改密码")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id",value = "人员信息id", required = true, paramType = "query"),
        @ApiImplicitParam(name = "security_code",value = "验证码", required = true, paramType = "query"),
        @ApiImplicitParam(name = "password",value = "新密码", required = true, paramType = "query")
    })
    public ResponseDto updateByPrimaryKeySelective(Integer id, String security_code, String password) {
        int count = 0;
        try {
            //先对验证码是否正确做验证（此处暂未处理）
            UserInfoDto userInfoDto = new UserInfoDto();
            userInfoDto.setId(id);
            userInfoDto.setPassword(password);
            count = service.modifyPwdById(userInfoDto);
            if(count <= 0) {
                return ControllerUtil.returnDto(false, "失败", count);
            }else {
                return ControllerUtil.returnDto(true, "成功", count);
            }
        } catch (Exception e) {
            logger.error("userInfo--modifyPwdById:系统异常");
            return ControllerUtil.returnDto(false, "系统异常", count);
        }
    }
    
    @ResponseBody
    @RequestMapping(value = "deleteByPrimaryKey", method = RequestMethod.GET)
    @ApiOperation(value = "根据id删除人员信息", notes = "根据id删除人员信息")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "人员信息id", required = true, paramType = "query")
    })
    public ResponseDto deleteByPrimaryKey(Integer id) {
        int count = 0;
        try {
            count = service.deleteByPrimaryKey(id);
            if(count <= 0) {
                return ControllerUtil.returnDto(false, "失败", count);
            }else {
                return ControllerUtil.returnDto(true, "成功", count);
            }
        } catch (Exception e) {
            logger.error("userInfo--deleteByPrimaryKey:系统异常");
            return ControllerUtil.returnDto(false, "系统异常", count);
        }
    }
    
    @ResponseBody
    @RequestMapping(value = "selectById", method = RequestMethod.GET)
    @ApiOperation(value = "根据id查询人员的所有信息", notes = "根据id查询人员的所有信息")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "人员信息id", required = true, paramType = "query")
    })
    public ResponseDto selectById(Integer id) {
        UserInfoDto dto = service.selectById(id);
        return ControllerUtil.returnDto(true, "成功", dto);
    }
}

五、访问

配置完成之后重启服务器，访问地址 http://localhost:8080/项目名/swagger-ui.html，如：

http://localhost:8080/spring-mvc/swagger-ui.html

访问之后的效果图如下：

 

访问效果图

点击具体的接口展开详情，效果图如下：

 

新增人员接口

在/userInfo/selectById 接口中输入相关参数，点击Try it out 按钮查看接口的返回值，如下：

{
  "success": true,
  "msg": "成功",
  "data": {
    "id": 1,
    "userNo": "admin",
    "userName": "管理员",
    "spellName": "guanliyuan",
    "password": "123",
    "userPhone": "18681558780",
    "userGender": 0,
    "createTime": "2017-06-27 01:56:28",
    "updateTime": "2017-07-26 15:56:05"
  }
}

六、参考资料

源码地址

swagger2 与 springmvc 整合 生成接口文档

一步步完成Maven+SpringMVC+SpringFox+Swagger整合示例

Spring MVC中使用 Swagger2 构建Restful API

Spring MVC中使用Swagger生成API文档和完整项目示例

SwaggerUI用户手册

七、拓展延伸

RAP



作者：颭夏
链接：http://www.jianshu.com/p/67c9b84226cd
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

 

 

 

 

 

bestcxx
关注
专栏目录
Spring Boot集成 Swagger2 展现在线接口文档
06-03
Spring Boot 集成 Swagger2 展现在线接口文档 Spring Boot 是一个基于 Java 的框架，用于快速构建生产级别的应用程序。Swagger 是一个流行的 API 文档工具，能够生成在线接口文档，帮助开发人员和调用接口的人员更...
[完美解决]springfox.documentation.builders.RequestHandlerSelectors.basePackage(Ljava/lang/String；)Ljava/
xujunming668的博客
07-13 2950
swagger的bug
关于springboot 配置 swagger2
liqing99_的专栏
05-21 628
一、配置Swagger 1、添加Swagger2的相关依赖到pom.xml文件中 <!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dep...
33.0、springboot-Swagger配置扫描接口以及开关、34.0、Swagger的分组和注释以及swagger对程序的测试
m0_52433668的博客
03-20 3369
32.0、springboot-Swagger配置扫描接口及开关 我们先来看看在SwaggerConfig.java文件： package com.hkl.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.Pat...
SpringBoot学习笔记03——SpringBoot整合Swagger
月月大王的博客
09-27 489
1.添加pom依赖 向pom文件中添加依赖 &lt;!-- swagger --&gt; &lt;dependency&gt; &lt;groupId&gt;io.springfox&lt;/groupId&gt; &lt;artifactId&gt;springfox-swagger2&lt;/artifactId&gt; &lt;version&gt;2.6.1&
springboot整合swagger
cj_ervin的博客
08-13 188
一、依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> </dependency> <dependenc...
Spring Boot集成Swagger2项目实战
08-28
Spring Boot集成Swagger2 在Spring Boot项目中集成Swagger2，主要分为两个步骤： 1. 引入依赖： 首先需要在项目的pom.xml文件中添加Swagger2相关的依赖，具体为`springfox-swagger2`和`springfox-swagger-ui`。这...
Spring Boot集成Swagger使用指南.pdf
05-12
文档为使用Spring Boot集成Swagger使用指南，主要包括swagger的组成，集成过程，以及常用注解的解释，通过文档应该可以使用swagger展示自己撰写的REST接口，进而更好的进行前后端交互。
Spring boot集成swagger2生成接口文档的全过程
08-25
接下来，我们将详细介绍如何在Spring Boot项目中集成Swagger2： 1. 创建一个新的Maven项目，确保项目结构合理。在项目的`pom.xml`文件中，我们需要添加Spring Boot的父依赖以及Swagger2的依赖。例如： ```xml <!-...
Spring Boot 2.7.5 集成 Swagger 3
最新发布
11-22
集成Swagger 3到Spring Boot项目中，可以帮助开发者更有效地管理和维护API，同时提供一个交互式的用户界面，让前端开发者能够轻松地了解和测试后端接口。 首先，要在Spring Boot 2.7.5项目中集成Swagger 3，我们...
基于Spring Boot项目的Swagger2
lyhhyl0205的博客
08-02 292
一：pom文件中引入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency&g...
springfox swagger-ui多个包路径扫描匹配的改造支持
iechenyb专栏
07-09 5053
使用springfox中的 RequestHandlerSelectors.basePackage("com.xxx") 只能支持单个包路径的扫描匹配,如果要想支持多个包路径的匹配我们需要修改springfox里面的代码来支持他，现做以下修改来支持多包路径匹配。package com.xxx.swagger; import org.springframework.beans.factory.ann...
Spring Boot 2.6.x整合Swagger启动失败报错问题解决（治标还治本）
热门推荐
Hello World
01-04 1万+
问题 Spring Boot 2.6.x版本引入依赖 springfox-boot-starter (Swagger 3.0) 后，启动容器会报错： Failed to start bean ‘ documentationPluginsBootstrapper ‘ ; nested exception…
swagger应用配置类
weixin_43035770的博客
01-09 389
swagger应用配置类 package com.user.swaggerconfig; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import springfox.documentation.builders.A...
spring boot项目中使用swagger2
weixin_45335305的博客
08-24 1517
一.介绍一下swagger 简单说明一下，Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档 二.如何使用 使用的spring boot+maven构建的web项目 第一步，pom文件中引入依赖 <dependency> <groupId>io.springfox</groupId> ...
SpringBoot 系列教程(四十三)：SpringBoot2.x集成Swagger2配置(解决404报错)
Thinkingcao的专栏
07-30 3359
在 spring boot 项目中配置 Swagger2 突然出现了 404 报错, 究其原因,是因为 MVC 没有找到 swagger-ui 包中的 swagger-ui.html 文件; 以下就是 swagger2 的配置,及解决方案: 一, 引入Maven : <dependency> <!-- API --> <...
Spring Boot基础教程30-Spring Boot集成Swagger
精进编程の博客
11-29 364
一、 Swagger 是什么？ Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。 http://swagger.io/ Springfox 的前身是 swagger-springmvc，是一个开源的 API doc 框架，可以将我们的 Controller 的 方法以文档的形式展现，基于 Swagger。 http://springfo...
SpringBoot gradle项目集成swagger
360linker
02-15 780
SpringBoot gradle项目集成swagger 1.简介以及原理 简介：  Java库的Springfox套件全部是关于使用spring项目编写的JSON API自动生成机器和人类可读的规范。Springfox的工作原理是在运行时检查应用程序，以便根据弹簧配置，类结构和各种编译时间的Java注释来推断API语义。  Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RES...
Spring Boot集成Swagger2：自动化RESTful API文档
Spring Boot集成Swagger2步骤： 1. 添加依赖：在项目的pom.xml文件中引入Springfox Swagger2的依赖，版本号为2.6.0。依赖如下： ```xml <groupId>io.springfox <artifactId>springfox-swagger2 <version>2.6.0 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值