使用 Swagger 来进行前后端协作

最新推荐文章于 2022-09-22 20:08:59 发布

MyHerux

最新推荐文章于 2022-09-22 20:08:59 发布

阅读量2.5k

点赞数

分类专栏： Java 敏捷开发文章标签： Swagger 2.8 前后端协作 Swagger常用注解

本文链接：https://blog.csdn.net/MyHerux/article/details/78655686

版权

本文介绍了如何利用Swagger进行前后端协作，包括配置Swagger、具体使用方式、生产环境下的禁用策略，以及Swagger常用注解的解释。通过Swagger，可以实现明确的接口输入输出，方便前端测试和开发。

摘要由CSDN通过智能技术生成

配置 Swagger

文档与 Github 库

引入依赖

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.8.0</version>
</dependency>

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

开启注解

在 Application 上添加注解 @EnableSwagger2

具体使用方式

需要注解的字段
- ApiOperation
  
  因为使用前后端分离，推荐所有参数为 json格式 ，所以在 notes 里面注明 需要 Mock 的静态输入。
```
@ApiOperation(value = "测试接口", notes = "示例数据：\n" + test)
@PostMapping("/test2")
public JSONObject 
```