IDEA技巧：如何根据注释生成swagger注解

相信大家在进行java项目开发，肯定会接触到swagger的，一款动态生成api文档的神奇，只需要在api上面加上注解，就可以生成文档，现在我简单介绍下swagger的快速入门，最后再说下如何根据注释快速生成这些烦人的注解。

swagger日常操作

引入swagger依赖

<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency>

开启swagger

@Configuration@EnableSwagger2//开启Swagger2public class Swagger2Config {}

swagger常用注解

@Api：修饰整个类，描述Controller的作用@ApiOperation：描述一个类的一个方法，或者说一个接口@ApiModel：用对象来接收参数 ，修饰类@ApiModelProperty：用对象接收参数时，描述对象的一个字段@ApiResponse：HTTP响应其中1个描述@ApiResponses：HTTP响应整体描述，一般描述错误的响应@ApiIgnore：使用该注解忽略这个API@ApiError ：发生错误返回的信息@ApiParam：单个参数描述@ApiImplicitParam：一个请求参数，用在方法上@ApiImplicitParams：多个请求参数

相信大家入门swagger肯定是不难的，但是大家估计都有一个共同的痛点，就是每次开发一个新接口的时候，要加上一堆注解，特别难受，有没有一款插件能够自动生成这些注解呢？

答案是有的。接下来我会给大家介绍下这款插件：Swagger Tools。

直接打开idea的插件仓库:搜索Swagger Tools，就可以直接安装。

安装之后重启下idea。

如何使用呢？
使用方式很简单，只要在需要生成注解的文件右击，选择gēgenerate->swaggerannotation，就可以直接生成，是不是很简单

本篇教程到此结束，后续会发布更多开发小技巧。

关注微信公众号“AI码师”，领取2021面试资料和最新全套微服务教程

IDEA技巧：如何根据注释生成swagger注解相关推荐

【SpringBoot】mybatis 自动生成swagger注解，及普通查询sql
1.项目结构 1.pom文件中的引入 <?xml version="1.0" encoding="UTF-8"?> <project xmln ...
java 生成并覆盖文件,基于mybatis-plus生成不被覆盖的文件并支持swagger注解
情况是这样的: 原本mybatis-plus的框架的模板是不支持swagger的注解的,需要手动写. 自己折腾了1个多小时,建立在mybatis-plus的基础上进行修改.可以选择生成文件时,不覆盖某 ...
generator代码自动生成工具（动态生成注释、类注解、方法注解等）适用于swagger等需要配置实体类的场景
generator代码生成器大家都不陌生,但是在实际的业务场景中,实体类只有属性.getter/setter方法不满足需求,还需要手动去添加需要的功能.比如项目使用swagger生成api文档时,需要 ...
什么是swagger以及swagger注解详解
1.什么是swagger Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言 ...
关于 mybatis-generator自定义注释生成使用DefaultCommentGenerator重写来完成
项目里新建表时model,mapper以及mapper.xml基本都是用Mybatis Generator(以下简称为MBG)自动生成的,但是MBG自动生成的model的注释实在有点非人类,至少中国人 ...
Bladex生成Swagger的方法
一.在启动类中添加如下代码:(目的是为了打印输出swagger的地址等) 注解:@Slf4j 实现接口:CommandLineRunner 依赖注入: @Autowiredprivate Enviro ...
swagger 扫描java文档_推荐一款在运行时通过javadoc生成Swagger API文档的库
介绍一般,我们使用Springfox生成swagger api文档,但Springfox不支持从javadoc中生成,只能通过注解的方式标注文档. 这样,当共享一些POJO类时,为了同时生成java ...
springboot 接口文档请求 enum_Spring Boot集成SpringFox 3：生成Swagger接口文档
SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
beego使用API自动化文档生成swagger时，routers目录下无法生成commentsRouter_controllers.go文件
今天项目生成swagger时,按照官方文档操作,swagger目录和压缩包都正常创建,就连http://localhost:8080/swagger/也正常访问,但是 Try it out 接口时,就 ...