如何使用Swagger在Linux上進行API版本管理

在Linux上使用Swagger進行API版本管理可以通過以下幾種方法實現：

1. 使用SpringFox和Swagger3進行API版本管理

如果你使用的是Spring Boot項目，可以利用SpringFox庫來集成Swagger并進行版本控制。

添加依賴

在pom.xml中添加SpringFox的依賴：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

配置Swagger

在Spring Boot配置類中配置Swagger，啟用版本控制：

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.OAS_30)
                .groupName("v1.0")
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiVersion.class, "1.0".equals(v.value())))
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("My API")
                .description("My API description")
                .version("1.0")
                .build();
    }
}

版本控制

在控制器中使用@ApiExplorerSettings注解來標記不同版本的API：

@RestController
@RequestMapping("/api/v1")
@ApiExplorerSettings(groupName = "V1")
public class V1Controller {
    // V1版本的API
}

@RestController
@RequestMapping("/api/v2")
@ApiExplorerSettings(groupName = "V2")
public class V2Controller {
    // V2版本的API
}

2. 使用OpenAPI Generator進行API版本管理

你可以使用OpenAPI Generator根據你的OpenAPI規范文件生成API文檔和客戶端庫。

安裝OpenAPI Generator

wget https://repo1.maven.org/maven2/io/swagger/openapi-generator-cli/2.4.21/openapi-generator-cli-2.4.21.jar -O openapi-generator.jar

生成API文檔

java -jar openapi-generator.jar generate -i openapi.yaml -l java -o ./generated-api

3. 使用Swagger Editor和Swagger UI進行API版本管理

你可以下載并安裝Swagger Editor和Swagger UI來管理和查看API文檔。

安裝Swagger Editor

wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v4.6.0.tar.gz
tar -xvf v4.6.0.tar.gz
cd swagger-editor-4.6.0
npm install
nohup npm start &

訪問Swagger Editor

打開瀏覽器，訪問 http://your_server_ip:8080 即可使用Swagger Editor。

安裝Swagger UI

wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html
unzip springfox-swagger-ui-2.9.2.html
sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui

配置Swagger UI

編輯 /var/www/html/swagger-ui/index.html 文件，找到以下行并進行修改：

script window.onload function () {
    const ui SwaggerUIBundle({
        url: "http://petstore.swagger.io/v2/api-docs",
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset],
        plugins: [SwaggerUIBundle.plugins.DownloadUrl],
        layout: "StandaloneLayout"
    });
}

啟動Web服務器

sudo a2ensite default.conf
sudo systemctl restart apache2

訪問Swagger UI

打開瀏覽器，訪問 http://your_server_ip:8080 即可使用Swagger UI。

通過上述方法，你可以在Linux上利用Swagger進行有效的API版本管理。選擇適合你項目需求的工具，可以大大簡化API文檔的維護和管理過程。