如何在Linux上配置Swagger以提高开发效率 - 问答

在Linux上配置Swagger可以通过以下步骤进行，以Spring Boot项目为例，使用springdoc库来集成Swagger 3.x，这是目前推荐的方式，因为它基于最新的OpenAPI 3.0规范。

安装Java环境和Maven

Swagger需要Java运行环境(JRE)或Java开发工具包(JDK)以及Maven进行构建和依赖管理。

# 安装OpenJDK
sudo apt update
sudo apt install openjdk-11-jdk

# 验证安装
java -version

# 安装Maven
sudo apt install maven

# 验证安装
mvn -version

引入Springdoc依赖

在你的Spring Boot项目中，添加springdoc-openapi-starter-webmvc-ui依赖到你的pom.xml文件中。

<dependency>
    <groupid>org.springdoc</groupid>
    <artifactid>springdoc-openapi-starter-webmvc-ui</artifactid>
    <version>2.1.0</version>
</dependency>

配置Swagger

创建一个配置类来启用Swagger。

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@OpenAPIDefinition(info = @Info(title = "Your API Title", version = "1.0", description = "Your API Description"))
public class SwaggerConfig {
    // 这里可以添加更多的配置，如果需要的话
}

启动Spring Boot应用

使用Maven构建并启动你的Spring Boot应用。

mvn clean install
java -jar target/your-application.jar

访问Swagger UI

启动应用后，打开浏览器访问http://localhost:8080/swagger-ui/，你应该能够看到Swagger UI的欢迎页面，以及自动生成的API文档。

其他Swagger编辑器

如果你需要使用Swagger Editor来编辑和验证你的OpenAPI规范，你可以下载并安装它。

# 下载Swagger Editor
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.16.1.tar.gz

# 解压
tar -xvf v3.16.1.tar.gz

# 进入解压后的目录
cd swagger-editor-3.16.1

# 启动Swagger Editor
npm install
node ./bin/swagger-editor.js

然后你可以通过浏览器访问http://localhost:8080来使用Swagger Editor。

以上步骤可以帮助你在Linux上配置Swagger，从而提高开发效率。记得根据你的具体项目需求进行相应的配置调整。

0 赞

0 踩