一、 准备工作

在开始搭建Swagger项目之前，确保你已经满足以下条件：

• 安装了Ubuntu操作系统
• 安装了Java Development Kit
• 安装了Maven或Gradle构建工具

二、安装Swagger依赖

在项目中，你需要添加Swagger的依赖。

    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2

三、 创建Swagger配置类

在你的项目中创建一个Swagger配置类，用于配置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
                .select
                .apis)
                .paths)
                .build;
    }
}

请将basePackage方法中的参数修改为你自己的包名。

四、 编写API接口

在你的项目中编写RESTful API接口，并使用Swagger注解来提供额外的元数据。

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@Api
public class UserController {
    @ApiOperation
    @GetMapping
    public User getUser Long id) {
        // 实现获取用户信息的逻辑
        return new User;
    }
}

五、 运行项目

使用Maven命令来编译和运行你的项目：

mvn clean install
mvn spring-boot:run

如果你使用的是Gradle，相应的命令会是：

gradle build
gradle bootRun

六、访问Swagger UI

一旦你的项目运行起来你可以你的API。默认情况下 Swagger UI可以通过以下URL访问：

http://localhost:8080/swagger-ui.html

确保你的应用程序运行在8080端口上，或者根据实际情况修改URL中的端口号。

更加高效。

---