在Debian系统中维护Swagger文档，可以参考以下步骤和建议：
添加依赖
假如你的项目采用maven进行管理，那么在 pom.xml 文件中添加以下依赖：
<dependency><groupid>io.springfox</groupid><artifactid>springfox-boot-starter</artifactid><version>3.0.0</version></dependency>
设置Swagger配置
在spring boot项目的 application.yml 文件里，添加如下配置：
springfox: documentation: swagger-ui: enabled: true
在项目内整合Swagger
在Controller中运用注解：
package com.example.demo.controller; import io.swagger.annotations.*; import org.springframework.web.bind.annotation.*; @RestController @RequestMapping("/api") @Api(tags = "Sample API") public class SampleController { @GetMapping("/hello") @ApiOperation(value = "Returns a greeting message") public String sayHello() { return "Hello, World!"; } }
打开Swagger UI
启动项目后，打开浏览器，访问 https://www.php.cn/link/6830bfbdb545d5f230744b3cce1f44c6。
对Swagger文档实施密码保护及登录验证
public class SwaggerAuthMiddleware { private readonly RequestDelegate _next; private readonly string _userName = "admin"; private readonly string _password = "password"; public bool _flag = true; public SwaggerAuthMiddleware(RequestDelegate next) { _next = next; } public async Task InvokeAsync(httpContext context) { if (context.Request.Path.StartsWithSegments("/swagger-ui") && _flag) { context.Request.Headers.Remove("Authorization"); context.Response.Headers["WWW-Authenticate"] = "Basic"; context.Response.Headers["Hello"] = "World"; context.Response.StatusCode = (int)HttpStatusCode.Unauthorized; _flag = false; return; } _flag = true; string authHeader = context.Request.Headers["Authorization"]; if (authHeader != null && authHeader.StartsWith("Basic")) { var header = AuthenticationHeaderValue.Parse(authHeader); var base64 = Convert.FromBase64String(header.Parameter); var credentials = Encoding.UTF8.GetString(base64).Split(':'); var username = credentials[0]; var password = credentials[1]; if (username.Equals(_userName) && password.Equals(_password)) { return; } } context.Response.StatusCode = (int)HttpStatusCode.Unauthorized; await _next(context); } }
- 配置中间件：在 Startup.cs 中配置中间件：
public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { app.UseMiddleware<swaggerauthmiddleware>(); // 其他中间件和路由配置 } </swaggerauthmiddleware>
通过上述方法，你便能够在Debian系统上维护和管理Swagger文档，并保障其安全性。
升级Swagger版本
在Debian系统上升级Swagger（通常是Swagger UI或Swagger Editor），可按以下步骤操作：
-
升级Swagger UI：
- 若尚未安装Swagger UI，先安装：
使用npm全局安装Swagger UI：
sudo npm install -g swagger-ui-express
已经安装Swagger UI的话，可通过npm更新它：
sudo npm update -g swagger-ui-express
若要安装指定版本的Swagger UI，可用以下命令：
sudo npm install -g swagger-ui-express@version
将 version 替换为你所需的Swagger UI版本号。
-
升级Swagger Editor：
- 若未安装Swagger Editor，先安装：
sudo apt updatesudo apt install nodejs npm
使用npm全局安装Swagger Editor：
sudo npm install -g swagger-editor-cli
已经安装Swagger Editor的话，可通过npm更新它：
sudo npm update -g swagger-editor-cli
如需安装特定版本的Swagger Editor，可用以下命令：
sudo npm install -g swagger-editor-cli@version
将 version 替换为你需要的Swagger Editor版本号。
希望这些指南能够协助你在Debian系统上顺利维护和管理Swagger文档。
