导入依赖

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

写配置方法

  @Configuration@EnableSwagger2public class SwaggerConfig {@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build();}}

代码中加注解示例

  @Controller@RequestMapping("/systemCreditRating")@Api(tags = "信用等级")public class CreditRatingController {private final Logger logger = LoggerFactory.getLogger(this.getClass());@Referenceprivate ICreditRatingService creditRatingService;@GetMapping("createCreditRating")@ResponseBody@ApiOperation(value = "新增信用等级")public Object createCreditRating(@RequestBody List<CreditRating> record) {// 返回接口工具类ResponseUtil responseUtil = ResponseUtil.createResponseUtil();//分值上限 下限 信用等级不能为空for (CreditRating creditRating : record) {if (StringUtils.isNotEmpty(creditRating.getMarkDown()) && StringUtils.isNotEmpty(creditRating.getMarkTop())&& StringUtils.isNotEmpty(creditRating.getCreditRating())) {try {logger.info("开始执行信息等级插入操作");if (creditRatingService.insert(record) < 0) {responseUtil.setMessage("执行信息等级插入失败");return responseUtil;}responseUtil.setMessage("执行信息等级插入成功");responseUtil.setSuccess(true);} catch (Exception e) {logger.error("执行信息等级插入出现异常");}}responseUtil.setMessage("分值上限、分值下限和信用等级均不能为空");}return responseUtil;}}

实体类加注解示例

@ApiModel(description = "信用等级实体")
public class CreditRating implements Serializable {
@ApiModelProperty("序号")
private Integer id;
@ApiModelProperty("分数")
private String mark;
@ApiModelProperty("分数下限")
private String markDown;
@ApiModelProperty("分数上限")
private String markTop;
@ApiModelProperty("信用等级")
private String creditRating;
@ApiModelProperty("备注")
private String remarks;
@ApiModelProperty("创建时间")
private Date createTime;
@ApiModelProperty("修改时间")
private Date updateTime; }

访问路径

http://localhost:8081/swagger-ui.html#/

Swagger使用方法相关推荐

Bladex生成Swagger的方法
一.在启动类中添加如下代码:(目的是为了打印输出swagger的地址等) 注解:@Slf4j 实现接口:CommandLineRunner 依赖注入: @Autowiredprivate Enviro ...
Swagger使用方法笔记
1. Swagger简介前后端分离前端 -> 前端控制层.视图层后端 -> 后端控制层.服务层.数据访问层前后端通过API进行交互前后端相对独立且松耦合产生的问题前后端集成, ...
Go使用swagger：方法说明+案例说明
https://blog.csdn.net/weixin_33728268/article/details/91365396
【 .NET Core 3.0 】框架之三 || swagger的使用
一.为什么使用Swagger 上文中已经说到,单纯的项目接口在前后端开发人员使用是特别不舒服的,那所有要推荐一个,既方便又美观的接口文档说明框架,当当当,就是Swagger,随着互联网技术的发展,现在 ...
.NET Core使用swagger进行API接口文档管理
一.问题背景随着技术的发展,现在的开发模式已经更多的转向了前后端分离的模式,在前后端开发的过程中,联系的方式也变成了API接口,但是目前项目中对于API的管理很多时候还是通过手工编写文档,每次的需求 ...
springMVC整合swagger(亲自试验完全可用)
swagger是什么: [plain] view plaincopyprint? Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件.本文简单介绍了在项目中集成swagger ...
Spring MVC学习总结（8）——Swagger入门详解
前言 Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件.本文简单介绍了在项目中集成swagger的方法和一些常见问题.如果想深入分析项目源码,了解更多内容,见参考资料. S ...
swagger访问开关配置
swagger Docket方法中有enable参数(类型为boolean,true表示开启swagger的访问,false表示关闭swagger的访问) import org.springframe ...
swagger 界面_使用Swagger和Scalatra进行界面驱动的开发简介
swagger 界面自从三年前开始使用以来,Scalatra网络微框架已经发展成为一个轻量级但功能齐全的模型-视图-控制器(MVC)框架,背后是一个活跃的社区. Scalatra最初是Ruby流行的 ...
Swagger注释路径不对
关于Swagger注释问题由于方法名重名问题,会导致Swagger注释方法的路径不对

Swagger使用方法