Debian上Swagger有哪些插件 - 问答

Debian上常见的Swagger相关插件及工具

1. Swagger UI

Swagger UI是Swagger生态的核心交互式文档工具，提供可视化的API接口展示与测试功能。在Debian上，可通过Node.js包管理器安装：

sudo apt update
sudo apt install swagger-ui-express  # 或通过npm全局安装：npm install -g swagger-ui-cli

安装后，通过访问http://<server-address>:<port>/api-docs即可查看自动生成的API文档界面。

2. Springfox

Springfox是针对Spring Boot项目的传统Swagger集成方案，支持自动生成Swagger 2规范的API文档。尽管已停止维护，仍被广泛使用。需通过Maven或Gradle引入依赖：

Maven配置：

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

Gradle配置：

implementation 'io.springfox:springfox-swagger2:2.9.2'
implementation 'io.springfox:springfox-swagger-ui:2.9.2'

配合Spring Boot的@EnableSwagger2注解即可启用。

3. springdoc-openapi

springdoc-openapi是Springfox的现代替代品，支持OpenAPI 3.0标准，兼容Spring Boot 3及以上版本。安装方式与Springfox类似：

Maven配置：

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.5.0</version>
</dependency>

Gradle配置：

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.5.0'

启用后，通过/swagger-ui.html访问文档。

4. smart-doc

smart-doc是一款无侵入式API文档生成工具，通过解析代码中的注解（如@Api、@ApiOperation）自动生成文档，支持导出Postman调试文件。在Debian上，通过Maven插件集成：

<plugin>
  <groupId>com.github.xiaoxian8023</groupId>
  <artifactId>smart-doc</artifactId>
  <version>1.11.11</version>
</plugin>

执行mvn smart-doc:html即可生成HTML格式文档。

5. Swagger Codegen

Swagger Codegen是代码生成工具，可根据OpenAPI规范（YAML/JSON）生成客户端SDK、服务端骨架或文档。在Debian上，通过以下命令下载CLI工具：

wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.29/swagger-codegen-cli-3.0.29.jar -O swagger-codegen-cli.jar

使用示例（生成HTML文档）：

java -jar swagger-codegen-cli.jar generate -i swagger.yaml -l html2 -o ./output

也可集成到Maven/Gradle构建流程中，实现文档自动生成。

6. Docsify

Docsify是轻量级文档生成工具，支持实时渲染Markdown文件，无需提前生成HTML。在Debian上，通过npm安装CLI工具：

sudo apt install npm
npm install -g docsify-cli

初始化文档目录后，通过docsify serve启动本地服务，访问http://localhost:3000即可实时预览文档。

7. Swagger Editor

Swagger Editor是基于Web的文档编辑器，用于编写、验证和测试OpenAPI规范（YAML/JSON）。在Debian上，可通过Docker快速部署：

docker run -d -p 8080:8080 swaggerapi/swagger-editor

访问http://localhost:8080即可使用，支持实时语法检查和文档预览。

以上插件覆盖了Swagger文档生成、编辑、测试、代码生成等全流程需求，可根据项目技术栈（如Spring Boot、Node.js）选择合适的工具。

0 赞

0 踩