溫馨提示×

Linux環境下Swagger如何調試

小樊
40
2025-05-01 07:46:38
欄目: 智能運維

在Linux環境下調試Swagger,可以參考以下步驟:

安裝Node.js和npm

確保你的Linux系統上已經安裝了Node.js和npm。如果沒有安裝,可以參考Node.js官方文檔進行安裝。

安裝Swagger Editor和Swagger UI

使用npm安裝

  1. 安裝Express
npm init -y
npm install express --save
  1. 創建并啟動Swagger Editor
mkdir /opt/swagger
cd /opt/swagger
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz
tar -xvf v3.16.1.tar.gz
rm v3.16.1.tar.gz
cd swagger-editor-3.16.1
npm install
node index.js

現在,你可以通過訪問 http://localhost:8081 來使用Swagger Editor。

  1. 創建并啟動Swagger UI
cd /opt/swagger
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.48.0.tar.gz
tar -xvf v3.48.0.tar.gz
rm v3.48.0.tar.gz
cd swagger-ui-3.48.0
npm install
node index.js

現在,你可以通過訪問 http://localhost:3000/api-docs 來使用Swagger UI。

使用Docker容器部署(推薦)

  1. 安裝Docker
sudo apt-get update
sudo apt-get install -y docker.io
sudo systemctl start docker
sudo systemctl enable docker
  1. 拉取鏡像
docker pull swaggerapi/swagger-ui:latest
docker pull swaggerapi/swagger-editor:latest
  1. 運行容器
docker run -d -p 8080:8080 swaggerapi/swagger-ui:latest
docker run -d -p 8081:8080 swaggerapi/swagger-editor:latest

訪問 http://localhost:8080 查看Swagger UI,訪問 http://localhost:8081 查看Swagger Editor。

配置Swagger

在你的Spring Boot項目中配置Swagger,可以參考以下步驟:

  1. 添加依賴
<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>
  1. 配置Swagger
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.example.demo.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}
  1. 使用Swagger注解

在你的Controller中使用Swagger注解來描述API。

通過以上步驟,你可以在Linux環境下配置和調試Swagger,方便API文檔的管理和測試。

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