溫馨提示×

ubuntu swagger如何進行網絡配置

小樊
41
2025-06-11 00:16:04
欄目: 智能運維

在Ubuntu上配置Swagger主要涉及安裝和配置Swagger Editor和Swagger UI,以及確保它們可以通過網絡訪問。以下是詳細步驟:

安裝Node.js和npm

首先,確保你的系統上已經安裝了Node.js和npm。如果沒有安裝,可以通過以下命令進行安裝:

sudo apt update
sudo apt install nodejs npm

安裝Swagger Editor和Swagger UI

使用npm全局安裝Swagger Editor和Swagger UI:

sudo npm install -g swagger-editornpm install -g swagger-ui

啟動Swagger Editor和Swagger UI

  1. Swagger Editor:

    • 啟動Swagger Editor后,訪問 http://localhost:8080 使用你保存的Swagger YAML文件進行API文檔的編輯和查看。
  2. Swagger UI:

    • 啟動Swagger UI后,訪問 http://localhost:3000,在頁面中輸入你的Swagger YAML文件的URL,然后點擊“Explore”按鈕查看和測試API。

配置Swagger

  1. 創建Swagger配置文件(例如 swaggerConfig.java):
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yourpackage")) // 替換為你的控制器包路徑
                .paths(PathSelectors.any())
                .build();
    }
}
  1. 訪問Swagger UI
    • 啟動你的Spring Boot應用程序后,你可以通過瀏覽器訪問Swagger UI界面。默認情況下,可以通過以下URL訪問:http://localhost:8080。這里假設你的應用程序運行在8080端口上。

使用Docker集成Swagger UI(可選)

如果你希望更方便地管理和部署Swagger,可以使用Docker:

  1. 安裝Docker
sudo apt update
sudo apt install docker.io
  1. 拉取并運行Swagger UI Docker鏡像
docker pull swaggerapi/swagger-ui-express
docker run -p 8080:8080 swaggerapi/swagger-ui-express

通過以上步驟,你就可以在Ubuntu上成功安裝和配置Swagger,并進行API文檔的生成和測試。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女