我正在编写一些 API,并且我想在编写代码时集成文档,所以我发现 Swagger 是实现此目的的好方法。
我使用了 Swagger 核心 v3 表示法,所以我的类类似于:
@RestController
@RequestMapping("/api/v1/bundles")
@OpenAPIDefinition(
info = @Info(
title = "Lifecycle Management RESTful API.",
version = "1",
description = "TODO",
license = @License(name = "Apache 2.0", url = "xxx"),
contact = @Contact(url = "xxx", name = "xx", email = "xxx@xxx.fr")
))
public class RestBundle {
@GetMapping(value = "/{nodeId}",
produces = MediaType.APPLICATION_JSON_VALUE)
@ResponseStatus(HttpStatus.OK)
@ResponseBody
@Operation(summary = "Get all bundles",
description = "Get all available bundles status from a specific node")
public Something(..) {
//Something ...
}
}
我创建了一个配置类:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("ANF Orchestrator")
.description("REST API for ANF Orchestrator")
.license("Apache 2.0")
.licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
.termsOfServiceUrl("")
.version("1.0.0")
.contact(new Contact("Amine","xxx", "aalaouie@laas.fr"))
.build();
}
}
并且我想启用 Swagger 的 UI 来获取文档,但是当我进入: .../swagger-ui.html
我得到:
无法呈现此定义 提供的定义未指定有效的版本字段。
请指明有效的 Swagger 或 OpenAPI 版本字段。支持的版本字段是 swagger:"2.0" 和那些匹配 openapi:3.0.n(例如,openapi:3.0.0)。