java - 如何从javadocs生成Swagger UI？

Question

我可以通过@Api，@ApiOperation批注在Spring引导应用程序上生成swagger UI。

这些注释使代码有点脏。我想知道如何从javadocs为我的API端点生成详尽的文档。

Answer 1

有一个简单的方法，您必须添加@ EnableSwagger2批注。

您可以在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>

在Spring Boot应用程序的主类中添加以下注释。

@EnableSwagger2
public class Authentic {

    public static void main(String[] args) {
        SpringApplication.run(Authentic.class, args);
    }
}

以下是访问API文档的方法。

例如网址:http://localhost:8080/swagger-ui.html#/