我正在将项目从 swagger 迁移到 springdoc openapi,并在使用 swagger-ui/index.html 端点时看到以下错误。
我的POM文件:
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
配置:
@Bean
public GroupedOpenApi api() {
return GroupedOpenApi.builder().group("Test")
.packagesToScan("com.test")
.pathsToMatch("/api.\*").build();
}
@Bean
public OpenAPI channelApiInfo() {
Contact contact = new Contact();
contact.setName("TestAPIs");
contact.setEmail("test.com");
return new OpenAPI()
.info(new Info().title("Test Service")
.description("This is a test service.")
.contact(contact));
}
端点配置:
@Operation(summary = "Test API", description = "This is a test api")
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Success"),
@ApiResponse(responseCode = "400", description = "ID is invalid")})
public @ResponseBody ResponseEntity\<Resource\> getId(
@Parameter(description = IdDesc, required = true) @PathVariable final String id) {
//Implementation
}
你可以查看openApi文档,第9点谈到了迁移,你可以有更好的想法。
https://springdoc.org/#migration-from-springfox
如果您只有一个 Docket — 将其删除,然后将属性添加到您的应用程序中。属性:
springdoc.packagesToScan=包1,包2 springdoc.pathsToMatch=/v1,/api/balance/**