关于Swagger API的建议

Question

我正在使用Java 8构建一个使用SpringBoot和SpringREST服务的API。我刚刚发现了Swagger API，现在我想让我的API与Swagger兼容。

据我所知，Swagger是一个记录您的APIS的工具，而且还提供了从规范（swagger.jsonv2中）生成客户端和服务器代码的功能，以及与您的API交互的漂亮Web界面。

现在，我想要一些关于如何继续的建议，因为我已经有了一个至少有15个控制器的现有应用编程接口。我应该从头开始编写整个规范（swagger.json文件），然后使用代码生成服务器代码（控制器和对象）吗？还是最好用斯瓦格核心注释注释现有控制器，然后从那里生成一个json规范？

第二个选择对我来说更有意义，但我不知道我们如何从现有 API 生成 swagger.json 规范（如果可能的话）。

关于这方面，你能给我一些建议吗？

谢谢

Answer 1

我意识到这来得太晚了，但是这里有一个可供您考虑的选择:您可以手写OpenAPI API描述，然后让您的实现在启动时读取它，并相应地自动配置它的URL路由、响应类型等，而不是从您的实现中生成OpenAPI API描述。

即从文档生成实现，而不是从实现生成文档。

我不知道这在Spring有多可行（对不起）。Python和WSGI并不难。

这是不是一个好主意，只有你才能做出判断。

Answer 2

只需对现有 REST API 进行少量注释，它就会自动生成整个 Swagger 规范。Swagger绝对是最受欢迎的REST API文档框架之一。

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.2.2</version>
    <scope>compile</scope>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
    <scope>compile</scope>
</dependency>

@Bean
public Docket newsApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .groupName("springboot")
            .apiInfo(apiInfo())
            .select()
            .paths(regex("/.*"))
            .build();
}
 
private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("SpringBoot REST API with Swagger")
            .description("SpringBoot REST API with Swagger")
            .termsOfServiceUrl("http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm?Open")
            .contact("sanket**@au1.ibm.com")
            .license("Apache License Version 2.0")
            .licenseUrl("https://github.com/IBM-Bluemix/news-aggregator/blob/master/LICENSE")
            .version("2.0")
            .build();
}

应用程序类的@EnableSwagger2

像这样的东西

@RequestMapping(value = "/operate/add/{left}/{right}", method = RequestMethod.GET, produces = "application/json")
@ApiOperation(value = "addNumbers", nickname = "addNumbers")
@ApiResponses(value = { @ApiResponse(code = 200, message = "Success", response = Result.class),
        @ApiResponse(code = 401, message = "Unauthorized"), 
        @ApiResponse(code = 500, message = "Failure") })
public Result add(@PathVariable("left") int left, @PathVariable("right") int right) {

您完成了。默认情况下包含Swagger UI，您还可以访问JSON格式的swagger规范。访问http://localhost:12001/swagger-ui.html#/

有关详细信息，请参阅此代码库：https://github.com/sanketsw/SpringBoot_REST_API