使用springdoc OpenAPI和spring boot starter数据mongodb生成OpenAPI文档

Question

我已经使用MongoDB启动了一个新的Spring Boot应用程序（2.2.1.RELEASE）。

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

为了创建一些API文档，我添加了springdoc API：

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-ui</artifactId>
  <version>1.1.49</version>
</dependency>

由于我依赖Spring来处理RESTendpoint的生成，因此我创建了以下简单的存储库：

@RepositoryRestResource(collectionResourceRel = "profile", path = "profile")
public interface ProfileRepository extends MongoRepository<Profile, String> {

  List<Profile> findByLastname(@Param("n") String lastname);
  List<Profile> findByFirstname(@Param("n") String firstname);
  List<Profile> findByEmail(@Param("e") String email);

}

所以我没有使用@RestController的类。

我试图添加一些io。大摇大摆v3。美洲国家组织。注释ProfileRepository中方法的注释，但不会生成任何内容。

@Operation(summary = "Find Profile by first name", description = "Find Profile by first name")
List<Profile> findByLastname(@Param("n") String lastname);

http://localhost:8080/v3/api-文档/：

json prettyprint-override">{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPI definition",
    "version": "v0"
  },
  "servers": [
    {
      "url": "http://localhost:8080",
      "description": "Generated server url"
    }
  ],
  "paths": {},
  "components": {}
}

如何为Spring数据REST存储库endpoint生成API文档？

Answer 1

从springdoc openapi的1.2.11版开始，添加org。springdoc:springdoc openapi数据rest依赖项将为Spring数据restendpoint生成API文档。

xml prettyprint-override"><dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-data-rest</artifactId>
  <version>1.5.10</version>
</dependency>

Answer 2

根据这一问题：https://github.com/springdoc/springdoc-openapi/issues/282，无法从spring boot starter数据rest生成OpenAPI文档，因为

Spring-data-rest实体endpoint在运行时动态生成[...]

在上面的GitHub问题上引用用户“bnasslahsen”的话。