Swagger-使用介绍

简介: Swagger

介绍

使用 swagger 只要按照规范去定义接口及接口相关信息,就可以生成接口文档,以及在线接口调试界面。
官网: https://swagger.io/

直接使用较为麻烦,可以使用 Knife4j 框架,是为 Java MVC框架集成 Swagger 生成 API 文档的增强解决方案。

使用方式

导入 Knife4f 的 maven 坐标

在配置类中加入 knife4f 的相关配置

设置静态资源映射,否则接口文档无法访问

常用注解

@Api

用在类上,表示对类的说明

@ApiModel

也是用在类上,例如 Entity,DTO,VO

@ApiModelProperty

用在属性上,描述属性信息

@ApiOperation

用在方法上,说明方法的用途、作用

目录
相关文章
|
7月前
|
JSON 数据库 数据格式
Swagger 中 allOf 的使用技巧
Swagger 提供了一个名为 allOf 的特性,它是通过扩展已有的数据模型来构造更为复杂的数据结构的有效手段。这一特性主要用于数据模型的继承及属性的组合,有效减少了代码重复,同时增强了代码的可维护性与清晰度。访问 Swagger 官方网站可以获得更多关于Swagger的详细信息。
|
7月前
|
Java API 开发者
Bladex生成Swagger的方法
Bladex生成Swagger的方法
|
JSON 前端开发 JavaScript
认识并了解Swagger
认识并了解Swagger
113 0
|
7月前
|
JSON 前端开发 Java
Swagger介绍及使用
Swagger介绍及使用
118 2
|
7月前
|
存储 API Go
Hertz 整合swagger
Hertz 整合swagger
94 0
|
前端开发 数据可视化 Java
从零学习Swagger3.0
从零学习Swagger3.0
168 0
|
前端开发 Java API
Swagger详解
Swagger详解
148 0
|
数据可视化 物联网 API
Swagger 学习笔记
Swagger 学习笔记
|
Java API Spring
|
数据可视化 前端开发 Java
swagger的使用
(1)@Api:用在类上,例如Controller,表示对类的说明 (2)@ApiModel:用在类上,通常是实体类,表示一个返回响应数据的信息 (3)@ApiModelProperty:用在属性上,描述响应类的属性 (4)@ApiOperation:用在请求方法上,说明方法的用途、作用 (5)@ApiImplicitParams:用在请求的方法上,表示一组参数的说明 (6)@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
136 0
swagger的使用
下一篇
DataWorks