Swagger工具介绍及整合web框架教程

最新推荐文章于 2024-09-19 19:36:22 发布

「已注销」

最新推荐文章于 2024-09-19 19:36:22 发布

阅读量4.4k

点赞数 3

分类专栏： # java开发文章标签： spring mvc swagger Jersey

本文链接：https://blog.csdn.net/aimomo007/article/details/78923173

版权

本文详细介绍了如何将Swagger与Jersey和Spring MVC进行整合，以实现RESTful API的自动化文档生成。首先，通过在项目中添加依赖、使用注解以及配置servlet，逐步展示了Swagger与Jersey的整合过程。接着，引入Springfox，通过添加依赖、配置参数和控制器注解，实现了Swagger与Spring MVC的集成，并展示了如何使用前端页面展示接口文档。最后，文中提及了整合过程中可能遇到的问题及其解决方案。

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

Swagger 介绍
整合Swagger和Jersey
整合Swagger和Spring MVC
- Springfox
- 踩过的坑

Swagger 介绍

Swagger [swægə]

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档。

Swagger 官网

swagger官网提供了四个工具： Swagger Editor、Swagger Codegen、Swagger UI和Swagger Inspector。

Swagger Editor：基于Swagger的API的开源编辑器上设计、描述和记录您的API。Swagger编辑器非常适合快速开始使用Swagger规范。它干净，高效，并配备了许多功能。

注：即使工具已经减轻了很多工作量，但是json文档写起来还是一个很繁琐的事情，于是乎，就有大神开发出了可以嵌入代码中直接生成json文档的工具，后面会介绍两种：Swagger整合Jersey和Swagger整合Spring MVC

Swagger Codegen：暂时还不清楚，有人了解可以留言给我，谢谢~

Swagger UI：根据Swagger规范生成的json文档转化成可视化前端界面。

Swagger Inspector：用来调用和验证REST、GraphQL和基于SOAP的Web服务，以确保它们正确运行。（和另一个名叫Postman工具相似，感兴趣的可以研究研究）

整合Swagger和Jersey

第一步在项目中加入依赖

compile(group: 'io.swagger', name: 'swagger-jersey2-jaxrs', version: '1.5.0') {
        exclude module: 'jackson-datatype-joda'
    }

第二步在程序用引入swgger注解

在程序中对应的Controller类中使用swagger注解，这里只展示最常用的几个，更加详细的参数信息可以在官网上查询。

@Api("User")
@Path("users")
public class UserApi {
   

  @Autowired
  private UserService userService;

  // 增
  @ApiOperation(value = "新增用户")
  @POST
  // 返回类型
  @Produces(MediaType.APPLICATION_JSON)
  //传入类型
  @Consumes(MediaType.APPLICATION_JSON)
  public Response addUser(UserDTO userDTO) {
    userService.addUser(userDTO);
    return Response.ok().build();
  }

  // 删
  @ApiOperation(value = "删除用户")
  @Path("{user_id}")
  @DELETE
  @Produces(MediaType.APPLICATION_JSON)
  public void deleteUser(@PathParam("user_id") String userId) {
    System.out.println("删除"+userId);
  }

  // 改
  @ApiOperation(value = "修改用户")
  @Path("{user_id}")
  @PUT
  @Produces(MediaType.APPLICATION_JSON)
  public void updateUser(@PathParam("user_id")