linux

Linux环境下Swagger如何调试

小樊
34
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
看了该问题的人还看了