本文介紹如何在Linux環境下配置Swagger,主要涵蓋Swagger ui和Swagger Editor的安裝與配置。
一、 使用docker容器部署 (推薦)
此方法簡化了安裝過程,避免了依賴管理的復雜性。
-
安裝Docker: 若未安裝Docker,請執行以下命令:
sudo apt-get update sudo apt-get install -y docker.io sudo systemctl start docker sudo systemctl enable docker
-
拉取鏡像: 分別拉取Swagger UI和Swagger Editor鏡像:
docker pull swaggerapi/swagger-ui:latest docker pull swaggerapi/swagger-editor:latest
(使用 latest 標簽獲取最新版本)
-
運行容器: 運行Swagger UI和Swagger Editor容器,并映射端口:
docker run -d -p 8080:8080 swaggerapi/swagger-ui:latest docker run -d -p 8081:8080 swaggerapi/swagger-editor:latest
訪問 http://:8080 查看Swagger UI,訪問 http://:8081 查看Swagger Editor。
二、 使用npm安裝 (適用于需要更精細控制的情況)
-
安裝Node.js和npm: 使用以下命令安裝:
-
安裝依賴: 安裝express和http-server:
npm install -g express http-server
-
安裝Swagger UI:
git clone https://github.com/swagger-api/swagger-ui.git cd swagger-ui npm install http-server -p 8080
-
安裝Swagger Editor:
git clone https://github.com/swagger-api/swagger-editor.git cd swagger-editor npm install http-server -p 8081
同樣,訪問 http://:8080 查看Swagger UI,訪問 http://:8081 查看Swagger Editor。
三、 spring Boot集成Swagger (適用于spring boot項目)
對于Spring Boot項目,推薦使用Springdoc OpenAPI來集成Swagger。
-
添加依賴: 在 pom.xml 文件中添加依賴:
<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <version>2.1.0</version> </dependency>
-
配置Swagger (可選): 可以創建一個配置類來自定義Swagger文檔信息:
import org.springdoc.core.models.GroupedOpenApi; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class SwaggerConfig { @Bean public GroupedOpenApi publicApi() { return GroupedOpenApi.builder() .group("public") .pathsToMatch("/public/**") .build(); } }
-
啟動應用: 啟動你的Spring Boot應用,訪問 http://:8080/swagger-ui/index.html 查看Swagger文檔 (端口可能因應用配置而異)。
通過以上方法,您可以在Linux環境下輕松配置Swagger,方便API文檔的管理和測試。 記住替換 為你的實際服務器IP地址。