在Linux上集成Swagger与Swagger Codegen可以帮助你自动化API文档的生成和更新。以下是一个基本的步骤指南:
首先,你需要安装Swagger Codegen。你可以使用Homebrew(如果你使用的是macOS)或者直接下载jar文件来安装。
brew install swagger-codegen
你可以从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
你需要一个Swagger规范文件(通常是swagger.json
或swagger.yaml
)。这个文件描述了你的API接口。
使用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客户端代码到指定的输出目录。
将生成的代码集成到你的项目中。你可以将这些代码作为依赖项添加到你的构建工具(如Maven或Gradle)中。
如果你使用Maven,可以在pom.xml
中添加以下依赖项:
<dependency>
<groupId>io.swagger.codegen.v3</groupId>
<artifactId>codegen</artifactId>
<version>3.0.30</version>
</dependency>
如果你使用Gradle,可以在build.gradle
中添加以下依赖项:
dependencies {
implementation 'io.swagger.codegen.v3:codegen:3.0.30'
}
为了在浏览器中查看和测试你的API文档,你可以使用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
将下载的文件放到你的Web服务器目录中,并创建一个HTML文件来加载Swagger UI。
<!DOCTYPE html>
<html>
<head>
<title>Swagger UI</title>
<link rel="stylesheet" type="text/css" href="swagger-ui-standalone-preset.css" />
<script src="swagger-ui-bundle.js"></script>
<script src="swagger-ui-standalone-preset.js"></script>
</head>
<body>
<div id="swagger-ui"></div>
<script>
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;
}
</script>
</body>
</html>
将url
参数替换为你的Swagger规范文件的URL。
启动你的Web服务器并访问Swagger UI页面,你应该能够看到你的API文档,并进行测试。
通过以上步骤,你可以在Linux上成功集成Swagger与Swagger Codegen,并生成和查看API文档。