swagger使用教程

2023-10-18 14:47:19 浏览数 (1)

1. 一、swagger简介

官网：https://swagger.io/

1、认识swagger

swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RestFul风格的web服务，总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器断的代码，允许API来始终保持同步。

作用：

  1. 接口的文档在线自动生成。
  2. 功能测试。

2、Swagger是一组开源项目，其中主要要项目如下：

Swagger-tools:提供各种与Swagger进行集成和交互的工具。例如模式检验、Swagger 1.2文档转换成Swagger 2.0文档等功能。

Swagger-core: 用于Java/Scala的的Swagger实现。与JAX-RS(Jersey、Resteasy、CXF…)、Servlets和Play框架进行集成。

Swagger-js: 用于JavaScript的Swagger实现。

Swagger-node-express: Swagger模块，用于node.js的Express web应用框架。

Swagger-ui：一个无依赖的HTML、JS和CSS集合，可以为Swagger兼容API动态生成优雅文档。

Swagger-codegen：一个模板驱动引擎，通过分析用户Swagger资源声明以各种语言生成客户端代码。

二、SpringBoot集成Swagger

1、新建SpringBoot项目，导入swagger依赖

代码语言：javascript复制
 <!--swagger依赖-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!--swagger ui-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2、编写swagger的配置文件

代码语言：javascript复制
@Configuration
@EnableSwagger2
public class Swagger2Config {
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 指定扫描的包路径来定义指定要建立API的目录。
     * @return
     */
    @Bean
    public Docket coreApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(adminApiInfo())
                .groupName("adminApi")
                .select()
                //只显示admin下面的路径
                .paths(Predicates.and(PathSelectors.regex("/admin/.*")))
                .build();
    }

    private ApiInfo adminApiInfo(){
        return new ApiInfoBuilder()
                .title("XXX后台管理系统--api文档")
                .description("XXX后台管理系统接口描述")
                .version("1.0")
                .contact(new Contact("XXX","http://baidu.com","XXXX@qq.com"))
                .build();
    }
}

3、添加文档内容

在完成了上述配置后，其实已经可以生产文档内容，但是这样的文档主要针对请求本身，描述的主要来源是函数的命名，通常需要自己增加一些说明来丰富文档内容。

Swagger使用的注解及其说明：

@Api：用在类上，说明该类的作用。 @ApiOperation：注解来给API增加方法说明。 @ApiParam：定义在参数上 @ApiResponses：用于表示一组响应 @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

code：数字，例如400 message：信息，例如"请求参数没填好" response：抛出异常的类

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

@ApiModelProperty：描述一个model的属性

@ApiImplicitParams: 用在方法上包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiImplicitParam的参数说明：

paramType：指定参数放在哪个地方

header：请求参数放置于Request Header，使用@RequestHeader获取 query：请求参数放置于请求地址，使用@RequestParam获取 path：（用于restful接口）–>请求参数的获取：@PathVariable body：（不常用） form（不常用）

name：参数名

dataType：参数类型

required：参数是否必须传

true ，false

defaultValue：参数的默认值

案例：

代码语言：javascript复制
//实体类
//entity的实体类中可以添加一些自定义设置
@Data
@ApiModel
@Table(name = "CHECK_ITEM")
public class CheckItemDTO {

    @ApiModelProperty("序号")
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    @ApiModelProperty("项目代码")
    @Column(name = "ITEM_CODE")
    private String itemCode;

    @ApiModelProperty("大项名称")
    @Column(name = "ITEM_NAME")
    private String itemName;

    @ApiModelProperty("价表项目代码")
    @Column(name = "PRICE_ITEM_CODE")
    private String priceItemCode;

    @ApiModelProperty("部位")
    @Column(name = "EXAM_SUB_CLASS")
    private String examSubClass;

    @ApiModelProperty("检查类别")
    @Column(name = "EXAM_CLASS")
    private String examClass;

    @ApiModelProperty("项目小项名称")
    @Column(name = "PRICE_ITEM_NAME")
    private String priceItemName;

    @ApiModelProperty(" 价表数量")
    @Column(name = "AMOUNT")
    private String amount;

    @ApiModelProperty("价表单价")
    @Column(name = "PRICE")
    private String price;

    @ApiModelProperty("有效标识")
    @Column(name = "VALID_INDICATOR")
    private String validIndicator;

}
代码语言：javascript复制
//controler层
/**
 * @Description: 定时任务
 */
@RestController
@RequestMapping("/sys/quartzJob")
@Slf4j
@Api(tags = "定时任务接口")
public class QuartzJobController {
    @Autowired
    private QuartzJobService quartzJobService;
    @Autowired
    private Scheduler scheduler;

    /**
     * 分页列表查询
     *
     * @param quartzJob
     * @param page
     * @param pageSize
     * @return
     */
    @ApiOperation(value = "分页列表查询", notes = "分页列表查询")
    @RequestMapping(value = "/list", method = RequestMethod.GET)
    public ApiResult queryPageList(QuartzJob quartzJob, @RequestParam(value = "page", defaultValue = "1") int page,
                                   @RequestParam(value = "pageSize", defaultValue = "20") int pageSize) {
        Page<QuartzJob> list = quartzJobService.selectList(quartzJob,page,pageSize);
        ApiResult apiResult = new ApiResult();
        if (CollectionUtils.isNotEmpty(list.getItems())){
            apiResult.setData(list);
        }
        return ApiResult.ok("list",list);

    }

    /**
     * 添加定时任务
     *
     * @param quartzJob
     * @return
     */
    //@RequiresRoles("admin")
    @ApiOperation(value = "添加定时任务", notes = "添加定时任务")
    @RequestMapping(value = "/add", method = RequestMethod.POST)
    public ApiResult add(@RequestBody QuartzJob quartzJob) {
        boolean b = quartzJobService.saveAndScheduleJob(quartzJob);
        if (b == true) {
            return ApiResult.ok("add");
        }
        return ApiResult.fail("add","添加定时任务失败");
    }
}

4.访问

完成上述代码，启动Spring Boot程序，访问：http://localhost:8080/swagger-ui.html

5.使用注意：

在DTO类上面的注解@ApiModel 并不代表此类会在Models中显示，需要此DTO正常被使用才会被扫描显示出来。并非此注解不生效~，在此注解里面填写此DTO的名称即可 我一般是@ApiModel(“TestDTO 测试类”) ，在DTO中其他字段的备注注解的话是使用@ApiModelProperty(value = “测试字段名称”)

swagger 定时任务 教程 接口 注解

0 人点赞