当前位置：首页 > 文章列表 > 文章 > linux > Linux上Swagger与SwaggerCodegen集成攻略

Linux上Swagger与SwaggerCodegen集成攻略

2025-04-16 20:27:35 0浏览收藏

本文提供Linux环境下Swagger与Swagger Codegen集成的完整指南，旨在帮助开发者自动化API文档的生成和更新。教程涵盖Swagger Codegen的安装（Homebrew或手动下载jar包）、Swagger规范文件的准备、使用命令行工具生成客户端代码（例如Java），以及将生成的代码集成到Maven或Gradle项目中。此外，文章还详细介绍了如何配置Swagger UI，方便用户在浏览器中查看和测试API文档，最终实现高效的API文档管理和维护。学习本指南，你将掌握在Linux系统上高效利用Swagger和Swagger Codegen的技巧。

在Linux上集成Swagger与Swagger Codegen可以帮助你自动化API文档的生成和更新。以下是一个基本的步骤指南：

1. 安装Swagger Codegen

首先，你需要安装Swagger Codegen。你可以使用Homebrew（如果你使用的是macOS）或者直接下载jar文件来安装。

使用Homebrew安装

brew install swagger-codegen

下载jar文件

你可以从Swagger Codegen GitHub Releases页面下载最新版本的jar文件。

wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/3.0.30/swagger-codegen-cli-3.0.30.jar

2. 准备Swagger规范文件

你需要一个Swagger规范文件（通常是swagger.json或swagger.yaml）。这个文件描述了你的API接口。

3. 生成客户端代码

使用Swagger Codegen生成客户端代码。假设你已经下载了jar文件并且有一个swagger.json文件。

java -jar swagger-codegen-cli-3.0.30.jar generate \
  -i /path/to/swagger.json \
  -l java \
  -o /path/to/output/directory

这个命令会生成Java客户端代码到指定的输出目录。

4. 集成生成的代码

将生成的代码集成到你的项目中。你可以将这些代码作为依赖项添加到你的构建工具（如Maven或Gradle）中。

使用Maven

如果你使用Maven，可以在pom.xml中添加以下依赖项：

<<span>dependency></span>
    <<span>groupId></span>io.swagger.codegen.v3</<span>groupId></span>
    <<span>artifactId></span>codegen</<span>artifactId></span>
    <<span>version></span>3.0.30</<span>version></span>
</<span>dependency></span>

使用Gradle

如果你使用Gradle，可以在build.gradle中添加以下依赖项：

dependencies {
    implementation 'io.swagger.codegen.v3:codegen:3.0.30'
}

5. 配置Swagger UI

为了在浏览器中查看和测试你的API文档，你可以使用Swagger UI。

下载Swagger UI

你可以从Swagger UI GitHub仓库下载Swagger UI的静态文件。

wget https://repo1.maven.org/maven2/io/swagger/swagger-ui/3.50.0/swagger-ui-bundle.js
wget https://repo1.maven.org/maven2/io/swagger/swagger-ui/3.50.0/swagger-ui-standalone-preset.css

配置Swagger UI

将下载的文件放到你的Web服务器目录中，并创建一个HTML文件来加载Swagger UI。

<!DOCTYPE <span>html></span>
<<span>html></span>
<<span>head></span>
    <<span>title></span>Swagger UI</<span>title></span>
    <<span>link rel="stylesheet" type="text/css" href="swagger-ui-standalone-preset.css" /></span>
    <<span>script src="swagger-ui-bundle.js"></span></<span>script></span>
    <<span>script src="swagger-ui-standalone-preset.js"></span></<span>script></span>
</<span>head></span>
<<span>body></span>
    <<span>div id="swagger-ui"></span></<span>div></span>
    <<span>script></span>
        <span>window.onload = function() {
            const ui = SwaggerUIBundle({
                url: "http://petstore.swagger.io/v2/swagger.json",
                dom_id: '#swagger-ui',
                deepLinking: true,
                presets: [
                    SwaggerUIBundle.presets.apis,
                    SwaggerUIStandalonePreset
                ],
                plugins: [
                    SwaggerUIBundle.plugins.DownloadUrl
                ],
                layout: "StandaloneLayout"
            });
            window.ui = ui;
        }
    </span></<span>script></span>
</<span>body></span>
</<span>html></span>

将url参数替换为你的Swagger规范文件的URL。