本文指導您如何在linux系統中使用Swagger進行API接口測試。
一、環境搭建
首先,我們需要安裝Swagger Editor和Swagger ui。推薦使用docker簡化安裝過程:
-
安裝Swagger Editor (Docker):
docker pull swaggerapi/swagger-editor:v4.6.0 docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0
-
安裝Swagger UI (Docker):
docker pull swaggerapi/swagger-ui:v4.15.5 docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5
二、配置與導入
-
導入Swagger配置文件: 啟動Swagger Editor (訪問http://localhost:38080),導入您的swagger.json或swagger.yaml文件。
-
spring Boot項目配置 (如果適用): 如果您使用spring boot,需要在pom.xml中添加Swagger依賴:
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.7.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.7.0</version> </dependency>
并編寫相應的Swagger配置類以啟用Swagger2。
三、啟動與測試
-
啟動Swagger Editor: 在瀏覽器中訪問http://localhost:38080,導入并編輯您的API文檔。
-
啟動Swagger UI: 訪問http://localhost:38081/swagger-ui.html,查看和測試您的API接口。 在Swagger UI界面中,您可以瀏覽接口文檔,查看請求參數和響應格式,并通過“try IT OUT”按鈕發送測試請求。
四、注意事項
- 確保Docker容器正常運行,端口映射正確。
- 如需增強Swagger UI安全性(例如添加身份驗證),請參考相關文檔進行配置。
完成以上步驟后,您便可以在Linux環境中高效地使用Swagger進行API接口測試。
? 版權聲明
文章版權歸作者所有,未經允許請勿轉載。
THE END