Swagger的三个常用注解

1. @Api

用于修饰类，在qs项目中用于描述Controller

参数：description 用于对该类的定义或描述该类的作用

@Api(description = "备忘录相关接口")
@RestController
public class MemoController {private final MemoRepository memoRepository;

    @Autowired
    public MemoController(MemoRepository memoRepository) {this.memoRepository = memoRepository;
    }

2. @ApiOperation

用于修饰方法或接口

参数：value = " ", 对方法的简述

note = " ", 对方法或接口的具体描述

/**
 * 查询
 *
 * @return
 */
@ApiOperation(value="根据用户id获取备忘录列表", notes="获取当前用户的所有备忘录")
@RequestMapping(value = "/{userId}/memos", method = RequestMethod.GET)
public ResultData list(@ApiParam(required = true, value = "用户id") @PathVariable("userId") String userId) {List<Memo> memos = memoRepository.findByUserId(userId);

    return ResultData.ok().putDataValue("memos", memos);
}

3. @ApiParam

用于对每个参数的描述

参数：required = true, 表示该参数是必要参数。

value, 对参数的描述

注：Swagger对所有参数是可选的(required可以是false),

但是当参数作为路径参数总是必须的，也就是说当参数出现在路径中时，required必须为true。

如下图代码中的userId.

/**
 * 按照memoId查找
 *
 * @param id
 * @return
 */
@ApiOperation(value="根据备忘录id获取备忘录信息", notes="获取当前备忘录信息")
@RequestMapping(value = "/{userId}/memos/{id}", method = RequestMethod.GET)
public ResultData find(@ApiParam(required = true, value = "用户id") @PathVariable("userId") String userId,
        @ApiParam(required = true, value = "备忘录id") @PathVariable("id") String id) {Memo memo = memoRepository.findOne(id);
    return ResultData.ok().putDataValue("memo", memo);
}

其他注解可参考http://www.cnblogs.com/java-zhao/p/5348113.html

Swagger的三个常用注解相关推荐

@aspect注解类不生效_Spring Boot从入门到精通（三）常用注解含义及用法分析总结...
Spring Boot是目前非常流行的框架,而注解是Spring Boot的核心功能,接下来主要说一说Spring Boot常用注解的含义以及部分注解在项目中的使用方法. @RestControlle ...
SpringBoot学习三：常用注解（配置相关）
SpringBoot常用注解(配置相关) 1.yml语法 ★注意空格 yml中的写法 properties中的写法 2.@Value获取值和@ConfigurationProperties获取值比较 ...
Spring Boot 1.5.8集成Swagger2 + YApi —— Swagger常用注解说明
前言受新型冠状病毒的影响,在家像猪一样不是睡就是吃,闲着就学着用下Swagger和YApi,特将这几天的学习成果写成了这系列的文章,希望能对大家有所帮助.武汉加油,中国加油! Spring Boot ...
Swagger 学习笔记 | Swagger 简介 | Springfox 简介 | Springfox 2.9.2 常用注解 | Spring Boot 整合 Swagger2 案例
文章目录一.Swagger 简介二.Springfox 简介三.Springfox2.9.2 常用注解四.SpringBoot 整合 Swagger2 4.1 引入Maven依赖 4.2 项目 ...
swagger注解说明_swagger2常用注解说明
原文:https://blog.csdn.net/u014231523/article/details/76522486 说明: 1.这里使用的版本:springfox-swagger2(2.4)sp ...
springmvc整合swagger 与常用注解说明
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使 ...
【Spring】Spring第三天 - 声明式事务、常用注解、Ajax 复习
一.自动注入 1.在Spring 配置文件中对象名和ref="id" . id 名相同,使用自动注入,可以不配置<property/> 2.两种配置办法 2.1 在&l ...
SpringMVC的常用注解(三)
白发戴花君莫笑,岁月从不败美人. 愿,像你我一如既往地好看. 上一章简单介绍了SpringMVC的'两个蝴蝶飞,你好'的简单开发(二),如果没有看过,请观看上一章. 一. SpringMVC的常用注解 ...
Swagger2常用注解说明
文章目录 Swagger2简介使用Swagger解决的问题 Spring Boot集成Swagger2 添加依赖添加Swagger2Config配置类编写接口用户DTO 用户controlle ...

Swagger的三个常用注解

Swagger的三个常用注解相关推荐

最新文章

热门文章