SpringBoot项目集成Swagger2
2019-10-22 10:33
78 查看
1.在pom文件中引入如下代码
[code]<!--swagger2引入 --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-bean-validators</artifactId> <version>2.9.2</version> </dependency>
2.Controller添加相应的信息注解
3.Application启动类增加@EnableSwagger2
4.请求地址
http://localhost:8093/interface/swagger-ui.html#这是访问地址
其中interface是当前服务的引用地址
5.引入注解说明
实体类注解
@ApiModelProperty()用于方法,字段; 表示对model属性的说明或者数据操作更改
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
控制器类注解
@Api:用在请求的类上,表示对类的说明
tags="说明该类的作用,可以在UI界面上看到的注解"
value="该参数没什么意义,在UI界面上也看到,所以不需要配置"
控制器方法注解
@ApiOperation() 用于方法;表示一个http请求的操作
value用于方法描述
notes用于提示内容
tags可以重新分组(视情况而用)
相关文章推荐
- springboot项目集成Swagger2
- Springboot项目集成Shiro+JWT,同时集成swagger2
- 项目(一)springboot多模块工程(3)集成mybatis-plus实现基本crud、集成swagger2接口管理
- 使用SpringBoot搭建小型项目,集成mybatis,redis,swagger2,并部署在外部容器中。
- Spring Boot集成Swagger2项目实战
- 【SpringBoot探索四】SpringBoot项目集成Swagger2管理接口文档
- Spring boot项目集成Neo4j
- 基于dubbo的分布式项目框架搭建 开发工具idea (springboot+dubbo+zookeeper+redis+rabbitmq+基于Swagger2的restful api) --(二)
- springboot项目集成redis共享session
- SpringBoot非官方教程 | 第十一篇:springboot集成swagger2,构建优雅的Restful API
- springboot项目利用Swagger2生成在线接口文档
- 在springboot项目中使用mybatis 集成 Sharding-JDBC
- 构建Springboot项目+后期集成
- springboot 集成 swagger2
- IDEASpringBoot/Maven项目集成lombok插件
- SpringBoot+Maven项目实战(2):集成SpringBoot
- (转) SpringBoot非官方教程 | 第十一篇:springboot集成swagger2,构建优雅的Restful API
- Springboot集成Swagger2
- springboot中rabbitmq集成——单项目
- SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)