Swagger2使用教程

最新推荐文章于 2024-07-30 17:38:36 发布

原创

最新推荐文章于 2024-07-30 17:38:36 发布 · 360 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#java #测试工程师 #扫描测试工具

本文详细介绍了Swagger2的用途、前后端分离的概念，并展示了如何在SpringBoot项目中集成Swagger2，包括Swagger的配置、使用注解进行接口文档定义，以及在正式环境中关闭Swagger的注意事项。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger

学习目标：

了解Swagger的作用和概念
了解前后端分离
在SpringBoot中集成Swagger

Swagger简介

前后端分离： 现在流行的Vue + SpringBoot
后端时代：前端只用管理静态页面：html、jsp、模板引擎。

前后端分离式时代：

后端：后端控制层，服务层，数据访问层【后端团队】
前端：前端控制层，视图层，伪造后端json数据【前端团队】
前后端通过API接口进行交互
前后端相对独立，松耦合
前后端甚至可以部属在不同服务器上

产生一个问题：

前后端集成联调，前端人员和后端人员无法做到 “即时协商，尽早解决”，最终导致问题集中爆发；

解决方案：

前端测试后端接口：postman
后端提供接口，需要实时更新最新的消息及改动！

Swagger

号称世界上最流行的API框架；
Restful Api 文档在线自动生成工具=>Api文档和接口同时更新
直接运行，可以在线测试API接口；
支持多种语言：（Java，Php…）

官网：https://swagger.io/

在项目中使用Swagger需要 springfox；

swagger2
ui

SpringBoot集成Swagger

1、新建一个SpringBoot项目。
2、导入相关依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId

最低0.47元/天解锁文章

200万优质内容无限畅学