@Spring Boot应用程序中通过Swagger生成的Java模型MongoDb中集合名称的文档注释

Question

我正在遵循的步骤

>

我为我的微服务编写API合同和定义模型的Swager文件

现在，我在Spring Boot应用程序中使用Swagger代码生成依赖项，通过从URL读取Swagger来生成模型，该URL位于我的应用程序“mvn安装”的目标（pom.xml中提到的输出目录）目录中。

对于 Swagger 文件中的每个定义，将在应用程序的目标目录中生成一个模型类。

现在我使用mongoDB作为模型的数据库，以保存为集合。

需要为模型类动态提供@Document（值 = “集合名称”） - 动态。

由于模型类是通过Swagger生成，codegen不能编辑它们，

那么如何维护我想保存在数据库中的定义的动态名称有什么方法可以通过 Swagger 合约来定义它吗？

Answer 1

不久前，我还在为同样的问题而苦苦挣扎，一些解决方案包括对生成的文件进行后处理。

然而，出于安全考虑，将MongoDB模型暴露于API可能并不完全正确。一个有趣的方法是简单地使用映射器并将DTO概念应用于自动生成的模型类。

例如:

假设您在MongoDB中有一个用户集合，并有一个API来检索用户。

components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
        name:
          type: string

Swagger自动生成的类是这样的：

package api;

@ApiModel()
@Validated
public class User   {
  @JsonProperty("id")
  private String id = null;

  @JsonProperty("name")
  private String name = null;
}

您还将拥有“标准”用户模型类:

package model;

@Document(collection = "users")
public class User {
    @Id
    private String id;
    @NotNull
    private String name;
    @NotNull
    private String password;
}

例如，请注意，密码字段不包含在 API 定义中。

然后我们将拥有典型的用户存储库：

public interface UserRepository extends MongoRepository<User, String> { }

现在我们必须实现映射器，使用 MapStruct 非常简单：

@Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
public interface UserMapper {
    api.User map(model.User user);
}

您可以广泛定制映射信息的内容和方式。

唯一剩下的就是控制器：

@Controller
public class MyController implements MyApi {

    @Inject
    UserMapper mapper;

    @Autowired
    private UserRepository repository;

    @GetMapping("/api/v1.0/users")
    public ResponseEntity<List<api.User>> getAllUsers() {
        List<api.User> users = new ArrayList<>();
        repository.findAll().forEach(user -> users.add(mapper.map(user)));
        return new ResponseEntity(users, HttpStatus.OK);
}