使用Swagger，Swagger-UI生成REST API接口文档

最新推荐文章于 2024-04-16 09:33:51 发布

clumsy_zhang

最新推荐文章于 2024-04-16 09:33:51 发布

阅读量2.2k

点赞数 2

CC 4.0 BY-SA版权

分类专栏：框架学习文章标签： swagger api rest

本文链接：https://blog.youkuaiyun.com/a280808306/article/details/53402517

Swagger,Swagger-UI是什么？

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和
文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
Swagger 让部署管理和使用功能强大的API从未如此简单。
Swagger-UI简单而一目了然。它能够纯碎的基于html+javascript实现，只要稍微整合一下便能成为方便的API在线测试工
具。项目的设计架构中一直提倡使用TDD（测试驱动）原则来开发，swagger-ui在这方面更是能提供很大帮助。

简单来说就是提供统一的接口文档，方便调试。通过swagger可以在文档接口界面上直接调试接口。可以直接集成到项目中通过
配置文件，来打开和关闭接口文档，方便使用。

springMVC 集成Swagger,Swagger-UI(最简单配置)

1. 引入pom依赖（springMVC配置可用）

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