Spring cloud 集成Swagger

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring cloud 集成Swagger相关的知识,希望对你有一定的参考价值。

参考技术A Swagger是基于REST APIs 定义一个标准的与语言无关的接口。通过查看这些接口了解到该请求的参数和返回结果。Swagger还提供了Web 界面Swagger UI,可以通过SwaggerUI进行测试接口。

springfox-swagger2 :Spring 集成Swagger 开箱即用的相关配置包
springfox-swagger-ui : web界面的包
swagger-springmvc :Swagger 使用的注解和相关Spring MVC 的配置

这里我们需要注意一下@EnableSwagger2,我们可以通过查看这个注解可以知道是使用Swagger2DocumentationConfiguration配置类来进行配置,而Swagger2DocumentationConfiguration集成了Spring MVC的配置,因为springfox-swagger-ui是一个web,需要进行swagger-ui.html的映射配置。如果我们使用了 @EnableSwagger2的时候我们就不需要使用@EnableWebMvc注解,如果2个同时使用的情况下会导致springfox-swagger-ui的/swagger-ui.html界面不可以访问。

@ApiModel :请求或者响应的Model
@ApiModelProperty :Model的属性
@ApiOperation:可以请求的方法
其他注解自己慢慢尝试。

请求访问的地址:http://localhost:8181/swagger-ui.html

Example Value :返回的JSON格式或者请求的JSON格式
parameters 中的Value 为请求的测试参数,可以点击Parameters中的Example Value 请求实例,就会复制一份请求参数到Value中

以上是关于Spring cloud 集成Swagger的主要内容,如果未能解决你的问题,请参考以下文章

Spring Cloud Gateway集成

Spring Cloud Hystrix集成

Spring cloud 集成Swagger

Spring Cloud微服务分布式云架构 - spring cloud集成项目

Spring Cloud Ribbon集成

Spring Cloud微服务分布式云架构 - spring cloud集成项目