怎么想springboot项目中使用swagger-spring-boot-starter

本文介绍如何使用swagger-spring-boot-starter快速生成API文档,包括依赖加入、配置细节及注释技巧,助您轻松掌握接口文档自动生成。

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

一直使用swagger,最近发现一款在swagger基础开发的api文档接口生成框架swagger-spring-boot-starter。我们先看看他生成的效果吧。


7798479-e29e0815443da1b0.png

1.加入依赖

7798479-98940fb7f61fe3ce.png

2.添加配置

spring.swagger.enabled=true

spring.swagger.security.filter-plugin=true

# 配置

spring.swagger.api-key.key-name=myToken

# 2.0.1 版本新特性 (支持可选的 Bean 验证插件)

# 配置账号密码

spring.swagger.security.username=battcn

spring.swagger.security.password=battcn

spring.swagger.base-package=com.cornerstone.verification.controller

# 关闭 JSR

spring.swagger.validator-plugin=false

3.启动项目输入:http://localhost:8083/swagger-ui.html 会有一个登陆接口 用户密码在配置文件里配置了。

4.一些swagger有用的注释:

(1)在接口上加上这个

@ApiImplicitParams({

@ApiImplicitParam(name="domainId",value="系统number",dataType="String",required=true),

        @ApiImplicitParam(name="username",value="用户名",dataType="String",required=true),

        @ApiImplicitParam(name="password",value="密码",dataType="String",required=true),

        @ApiImplicitParam(name="redirect",value="重定向地址",dataType="String",required=false)

})

注释参数信息。

### 如何使用 `swagger-spring-boot-starter` 生成和管理 API 文档 #### 添加 Maven 依赖 为了在 Spring Boot 应用程序中启用 Swagger2 功能,需引入 `swagger-spring-boot-starter` 的 Maven 依赖项。对于版本1.6.0及以上,应采用如下配置: ```xml <dependency> <groupId>com.spring4all</groupId> <artifactId>swagger-spring-boot-starter</artifactId> <version>${latest.version}</version> </dependency> ``` 此操作确保应用程序能够利用 Swagger 提供的功能自动生成 RESTful Web Services 的交互式文档[^2]。 #### 启用 Swagger 支持 通过在主启动类上添加 `@EnableSwagger2Doc` 注解来激活 Swagger 自动生成功能。这一步骤使得应用可以识别并处理带有特定注释的方法与参数,从而创建详细的接口描述信息[^5]。 ```java @EnableSwagger2Doc @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } } ``` #### 配置 Swagger 属性 可以通过设置 application.properties 或者 application.yml 文件中的属性来自定义 Swagger 行为。例如指定基本路径、主机名以及其他高级选项等。具体配置详情参阅官方指南[^3]。 #### 编写带注解的控制器方法 为了让 Swagger 正确解析 HTTP 请求映射关系,在编写 RestController 类及其内部函数时应当合理运用各种 Javadoc 和 Swagger 特定标签(如 @ApiOperation,@ApiParam)。这些标记不仅有助于提高代码可读性和维护性,同时也让生成出来的 API 文档更加清晰易懂。 ```java @RestController @RequestMapping("/users") @Api(tags = "用户模块", description="提供用户的增删改查服务") public class UserController { @GetMapping("/{id}") @ApiOperation(value = "获取单个用户的信息", notes = "") public ResponseEntity<UserDTO> getUser(@PathVariable Long id){ ... } // Other CRUD operations... } ``` 完成上述步骤之后,当成功部署并运行该 Spring Boot 应用后,即可通过浏览器访问 http://localhost:8080/swagger-ui.html 查看实时更新后的 API 文档页面[^1]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值