swagger接口展示及调试

1，简介
swagger主要用于前后端分离，供前端查看接口详情，后端调试的工具。
Swagger UI: http://localhost:8887/doc.html#
2，jar包依赖

io.springfox
springfox-swagger2
2.9.2


io.springfox
springfox-swagger-ui
2.9.2

2，代码：
package com.zkml.hkm.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

• @author hyg

• @date 2021/12/1 9:52
  */
  @Configuration
  @EnableSwagger2
  @ConditionalOnProperty(value = {“swagger.enable”}, matchIfMissing = true)
  public class SwaggerConfiguration {

  @Bean
  public Docket petApi(){
  return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.basePackage(“com.zkml.hkm”)).build();
  }

  private ApiInfo apiInfo(){
  return new ApiInfoBuilder().title(“后台服务接口测试”).contact(new Contact(“123”,“456”,“789”))
  .description(“接口测试”).version(“1.0”).license(“my”).build();
  }

}

package com.zkml.hkm;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

• @author ASUS
  */
  @SpringBootApplication
  @EnableSwagger2
  @EnableSwaggerBootstrapUI
  @EnableScheduling
  public class HkmApplication {

  public static void main(String[] args) {
  SpringApplication.run(HkmApplication.class, args);
  }

}

package com.zkml.hkm.web.business.controller;

import com.zkml.hkm.common.ResponseBean;
import com.zkml.hkm.web.business.pojo.dto.PremiumDto;
import com.zkml.hkm.web.business.service.PremiumService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**

• @author xie

• @Date 2022/01/13
  */
  @Api(value = “保费管理”, tags = “保费管理”)
  @RestController
  @RequestMapping("/hkm/premium")
  public class PremiumController {

  @Autowired
  private PremiumService premiumService;

  /**

  • 获取保费总行列表
  • @param premiumDto
  • @return
    */
    @PostMapping(value = “/queryPremiumInfoList”)
    @ApiOperation(“获取保费总行列表”)
    public ResponseBean queryPremiumBankList(@RequestBody PremiumDto premiumDto){
    return premiumService.queryPremiumBankList(premiumDto);
    }

  /**

  • 获取保费支行列表
  • @param premiumDto
  • @return
    */
    @PostMapping(value = “/queryPremiumBranchList”)
    @ApiOperation(“获取保费支行列表”)
    public ResponseBean queryPremiumBranchList(@RequestBody PremiumDto premiumDto){
    return premiumService.queryPremiumBranchList(premiumDto);
    }

  /**

  • 获取保费列表详情
  • @param premiumDto
  • @return
    */
    @PostMapping(value = “/queryPremiumBankDetail”)
    @ApiOperation(“获取保费列表详情”)
    public ResponseBean queryPremiumBankDetail(@RequestBody PremiumDto premiumDto){
    return premiumService.queryPremiumBankDetail(premiumDto);
    }

  /**

  • 根据项目编码获取保费基础信息
  • @param premiumDto
  • @return
    */
    @PostMapping(value = “/queryPremiumBankInfo”)
    @ApiOperation(“根据项目编码获取保费基础信息”)
    public ResponseBean queryPremiumBankInfo(@RequestBody PremiumDto premiumDto){
    return premiumService.queryPremiumBankInfo(premiumDto);
    }

}

package com.zkml.hkm.web.business.pojo.dto;

import com.zkml.hkm.common.PageBean;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**

• 保费管理参数

• @author xie

• @Date 2022/01/13
  */
  @ApiModel(description = “保费管理参数”)
  @Data
  public class PremiumDto extends PageBean {

  /**

  • 项目编号
    */
    @ApiModelProperty(value = “项目编号”)
    private String orderNo;

  /**

  • 银行名称
    */
    @ApiModelProperty(value = “银行名称”)
    private String bankName;

  /**

  • 银行代码
    */
    @ApiModelProperty(value = “银行代码”)
    private String bankCode;

  /**

  • 保费银行代码
    */
    @ApiModelProperty(value = “保费银行代码”)
    private String premiumBankCode;

  /**

  • 支行名称
    */
    @ApiModelProperty(value = “支行名称”)
    private String branchName;

  /**

  • 支行名称（用于等值查询）
    */
    @ApiModelProperty(value = “支行名称（用于等值查询）”)
    private String realBranchName;

  /**

  • 开始日期
    */
    @ApiModelProperty(value = “开始日期”)
    private String startDate;

  /**

  • 结束日期
    */
    @ApiModelProperty(value = “结束日期”)
    private String endDate;

  /**

  • 贷款主体
    */
    @ApiModelProperty(value = “贷款主体”)
    private String loanApplicantName;

  /**

  • 证件编号
    */
    @ApiModelProperty(value = “证件编号”)
    private String loanApplicantIdcard;

  /**

  • 合同编号
    */
    @ApiModelProperty(value = “合同编号”)
    private String contractNo;

  /**

  • 缴费方式
    */
    @ApiModelProperty(value = “缴费方式”)
    private String paymentWay;

  /**

  • 下发时间
    */
    @ApiModelProperty(value = “下发时间”)
    private String fileDate;

  /**

  • 登录用户
    */
    @ApiModelProperty(value = “登录用户”)
    private String registerName;

  /**

  • 县区编号
    */
    @ApiModelProperty(value = “县区编号”)
    private String orderCounty;

}