swagger如何访问（swagger怎么访问）

科技前沿 • 2025-04-21 17:07 • 阅读 48

大家好，我是讯享网，很高兴认识大家。

 <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0);"></path> </svg>

讯享网

Swagger 是一套基于 OpenAPI 规范构建的开源工具，可以帮助我们设计、构建、记录以及使用 Rest API。

当下很多公司都采取前后端分离的开发模式，前端和后端的工作由不同的工程师完成。在这种开发模式下，维持一份及时更新且完整的 Rest API 文档将会极大的提高我们的工作效率。传统意义上的文档都是后端开发人员手动编写的，相信大家也都知道这种方式很难保证文档的及时性，这种文档久而久之也就会失去其参考意义，反而还会加大我们的沟通成本。而 Swagger 给我们提供了一个全新的维护 API 文档的方式，下面我们就来了解一下它的优点：

讯享网

1.3.1 引入依赖

1.3.2 启用Swagger2

讯享网

1.3.3 访问测试一下

访问：http://localhost:8888/swagger-ui.html 注意其中localhost和8888要调整成实际项目的域名和端口号。

1.4.1 Controller配置—@Api 注解

属性介绍：

tags 设置标签

讯享网

description 设置描述信息

讯享网

1.4.2 接口配置

1.4.2.1 接口描述配置@ApiOperation

1.4.2.2 接口参数描述

@ApiImplicitParam 用于描述接口的参数，但是一个接口可能有多个参数，所以一般与 @ApiImplicitParams 组合使用。

讯享网

1.4.3 实体类配置

1.4.3.1 实体的描述配置@ApiModel

@ApiModel用于描述实体类。

1.4.3.2 实体的属性的描述配置@ApiModelProperty

@ApiModelProperty用于描述实体的属性

讯享网