在Debian上使用Swagger进行API设计-linux运维-PHP中文网

在Debian上使用Swagger进行API设计

小老鼠

发布： 2025-06-19 11:26:33

原创

221人浏览过

在debian系统上利用openapi规范（即原swagger）进行api设计，通常需完成如下步骤：

引入Swagger依赖：首先需要在Spring Boot项目中加入Swagger相关依赖。可以使用Maven或Gradle来实现。下面展示的是通过Maven添加依赖的方式：

<code><dependencies><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></dependencies></code>

登录后复制

请注意将示例中的版本号替换为你实际使用的版本。

设置Swagger配置：接下来，创建一个配置类以启用Swagger并设定基础信息。以下是一个基本的配置样例：

<code>import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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.any())
                .paths(PathSelectors.any())
                .build();
    }
}</code>

登录后复制

该配置类激活了Swagger功能，并指示其扫描所有可用的API接口以生成文档。

利用注解描述API内容：在Controller类中使用Swagger提供的注解来说明API的具体功能。例如：

<code>import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;

@Api(tags = "Sample API")
public class SampleController {
    @ApiOperation(value = "Get sample data", notes = "Returns a sample data")
    public String getSampleData() {
        return "Sample Data";
    }
}</code>

登录后复制