【轻松上手】Swagger Java示例，快速构建API文档攻略

引言

在软件开辟过程中，API文档是至关重要的。它不只帮助开辟者懂得跟利用你的API，还能进步代码的可保护性跟可读性。Swagger是一个风行的API文档跟测试东西，可能帮助你轻松地创建跟测试API文档。本文将供给一个Swagger Java示例，帮助你疾速构建API文档。

Swagger简介

Swagger是一个基于OpenAPI标准的东西，用于描述、出产跟测试RESTful API。它供给了易于利用的界面，可能让你轻松地定义API的接口、参数、呼应等，并主动生成API文档。

安装依附

起首，你须要在你的Java项目中增加Swagger的依附。假如你利用Maven，可能在pom.xml文件中增加以下依附：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

创建Swagger设置

接上去，你须要创建一个Swagger设置类，用于设置Swagger的相干参数。

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.basePackage("com.example.demo"))
                .paths(PathSelectors.any())
                .build();
    }
}

在这个示例中，我们设置了Swagger的扫描包道路为com.example.demo，你可能根据你的项目道路停止修改。

创建API接口

现在，你可能创建一个API接口，并利用Swagger注解来描述它的参数、呼应等。

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api(tags = "用户管理")
public class UserController {

    @GetMapping("/user")
    @ApiOperation(value = "获取用户信息", notes = "根据用户ID获取用户信息")
    @ApiResponses(value = {
            @ApiResponse(code = 200, message = "成功", response = User.class),
            @ApiResponse(code = 404, message = "用户不存在")
    })
    public User getUser(@RequestParam("id") Long id) {
        // 模仿获取用户信息
        User user = new User();
        user.setId(id);
        user.setName("张三");
        return user;
    }
}

在这个示例中，我们创建了一个名为UserController的把持器类，并定义了一个名为getUser的方法。我们利用Swagger注解来描述这个方法的参数、呼应等。

启动项目

最后，启动你的项目，并拜访http://localhost:8080/swagger-ui.html，你将看到一个Swagger的UI界面，其中包含了你的API文档。

总结

经由过程以上步调，你就可能利用Swagger疾速构建API文档了。Swagger供给了丰富的功能跟机动性，可能帮助你更好地管理你的API。