集成Open API

在Spring Boot应用中，假设我们编写了一堆REST API，如何添加Open API的支持？

我们只需要在中加入以下依赖：

然后呢？没有然后了，直接启动应用，打开浏览器输入http://localhost:8080/swagger-ui.html：

因为我们引入springdoc-openapi-ui这个依赖后，它自动引入Swagger UI用来创建API文档。可以给API加入一些描述信息，例如：

public class ApiController {
    ...
    @Operation(summary = "Get specific user object by it's id.")
    public User user(@Parameter(description = "id of the user.") @PathVariable("id") long id) {
    }
    ...

@Operation可以对API进行描述，@Parameter可以对参数进行描述，它们的目的是用于生成API文档的描述信息。添加了描述的API文档如下：

大多数情况下，不需要任何配置，我们就直接得到了一个运行时动态生成的可交互的API文档，该API文档总是和代码保持同步，大大简化了文档的编写工作。

从下载练习：利用springdoc实现API文档 （推荐使用快速下载）

使用springdoc让其自动创建API文档非常容易，引入依赖后无需任何配置即可访问交互式API文档。

可以对API添加注解以便生成更详细的描述。