Swagger在Ubuntu上的使用技巧

发布时间:2025-04-04 00:54:42

阅读量:288

Swagger是一款RESTful接口的文档在线自动生成及功能测试工具，它可以帮助开发者规范化、标准化接口文档，并支持接口的联调和测试。以下是在Ubuntu上使用Swagger的一些技巧和步骤：

安装Swagger UI安装Node.js和npm：安装Express和其他必要的模块：部署Swagger UI：在Spring Boot项目中集成Swagger引入Swagger依赖：

在pom.xml中添加以下依赖：

<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger2artifactId>
    <version>2.7.0version>
dependency>
<dependency>
    <groupId>io.springfoxgroupId>
    <artifactId>springfox-swagger-uiartifactId>
    <version>2.7.0version>
dependency>

配置Swagger：

创建一个配置类，使用@Configuration和@EnableSwagger2注解来启用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.any())
                .paths(PathSelectors.any())
                .build();
    }
}

使用Swagger注解：

在Controller中使用Swagger注解来描述API接口，例如：

import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
    @ApiOperation(value = "Get user by ID", notes = "Returns a user based on the ID provided")
    @GetMapping("/users/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        // 实现获取用户的逻辑
        return new User(id, "John Doe");
    }
}