什么是swagger以及swagger注解详解

1.什么是swagger
Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说，Swagger是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分离解决方案。
Swagger有大致有3个优点：
1.Swagger可以整合到代码中，在开发时通过注解，编写注释，自动生成API文档。
2.将前端后台分开，不会有过分的依赖。
3.界面清晰，无论是editor的实时展示还是ui的展示都十分人性化，如果自己仅仅用markdown来编写，又要纠结该如何展现，十分痛苦。

2.swagger注解
swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。

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

什么是swagger以及swagger注解详解相关推荐

26.SpringBoot事务注解详解
转自:https://www.cnblogs.com/kesimin/p/9546225.html @Transactional spring 事务注解 1.简单开启事务管理 @EnableTrans ...
mybatis注解详解
mybatis注解详解首先当然得下载mybatis-3.0.5.jar和mybatis-spring-1.0.1.jar两个JAR包,并放在WEB-INF的lib目录下 (如果你使用maven,则 ...
开启注解缓存_Spring Boot 2.x基础教程：进程内缓存的使用与Cache注解详解
随着时间的积累,应用的使用用户不断增加,数据规模也越来越大,往往数据库查询操作会成为影响用户使用体验的瓶颈,此时使用缓存往往是解决这一问题非常好的手段之一.Spring 3开始提供了强大的基于注解的缓 ...
spring-boot注解详解(一)
spring-boot注解详解(一) @SpringBootApplication @SpringBootApplication = (默认属性)@Configuration + @EnableAut ...
Spring零配置之@Configuration注解详解
转载自 Spring零配置之@Configuration注解详解 @Configuration介绍 Spring3.0之前要使用Spring必须要有一个xml配置文件,这也是Spring的核心文件,而 ...
Spring Boot注解详解
文章目录使用注解的优势注解详解(配备了完善的释义) 注解列表如下 JPA注解 springMVC相关注解全局异常处理项目中具体配置解析和使用环境使用注解的优势采用纯java代码,不在需要配 ...
【SpringBoot 】SpringBoot注解详解
[SpringBoot ]SpringBoot注解详解一.注解(annotations)列表 @SpringBootApplication:包含了@ComponentScan.@Configura ...
java method 注解_JAVA 注解详解及简单实例
JAVA 注解详解及简单实例何为注解注解(Annotation)又称为元数据,在JDK1.5后引入,它的作用是: 生成文档这是注解的原始用途,可以通过注解生成JavaDoc文档跟踪代码的依赖 ...
Java基础13：反射与注解详解
Java基础13:反射与注解详解什么是反射? 反射(Reflection)是Java 程序开发语言的特征之一,它允许运行中的 Java 程序获取自身的信息,并且可以操作类或对象的内部属性. Orac ...
@Profile注解详解
@Profile注解详解 @Profile: Spring为我们提供的可以根据当前环境,动态的激活和切换一系列组件的功能: 开发环境develop.测试环境test.生产环境master 数据源:(/ ...

什么是swagger以及swagger注解详解

什么是swagger以及swagger注解详解相关推荐

最新文章

热门文章