在linux上集成swagger與swagger codegen可以幫助你自動(dòng)化api文檔的生成和更新。以下是一個(gè)基本的步驟指南：
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. 準(zhǔn)備Swagger規(guī)范文件
你需要一個(gè)Swagger規(guī)范文件（通常是swagger.json或swagger.yaml）。這個(gè)文件描述了你的API接口。
3. 生成客戶端代碼
使用Swagger Codegen生成客戶端代碼。假設(shè)你已經(jīng)下載了jar文件并且有一個(gè)swagger.json文件。
Java -jar swagger-codegen-cli-3.0.30.jar generate -i /path/to/swagger.json -l java -o /path/to/output/directory
4. 集成生成的代碼
將生成的代碼集成到你的項(xiàng)目中。你可以將這些代碼作為依賴項(xiàng)添加到你的構(gòu)建工具（如Maven或gradle）中。
使用Maven
如果你使用Maven，可以在pom.xml中添加以下依賴項(xiàng)：
<<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中添加以下依賴項(xiàng)：
dependencies { implementation 'io.swagger.codegen.v3:codegen:3.0.30' }
5. 配置Swagger ui
為了在瀏覽器中查看和測試你的API文檔，你可以使用Swagger UI。
下載Swagger UI
你可以從Swagger UI GitHub倉庫下載Swagger UI的靜態(tài)文件。
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服務(wù)器目錄中，并創(chuàng)建一個(gè)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參數(shù)替換為你的Swagger規(guī)范文件的URL。
6. 運(yùn)行和測試
啟動(dòng)你的Web服務(wù)器并訪問Swagger UI頁面，你應(yīng)該能夠看到你的API文檔，并進(jìn)行測試。
通過以上步驟，你可以在Linux上成功集成Swagger與Swagger Codegen，并生成和查看API文檔。
.png)
推廣.jpg)