首页 > 解决方案 > 对于包含客户端代码的模块,建议使用什么命名约定?

问题描述

我正在一个名为<api-name>-server.

为了方便客户,我想开发一个客户端模块,<api-name>-client. 客户端模块将处理所有的 HTTP 方法调用和类似的东西。如果我们有一个库来调用 API 端点,我希望这也能稍微简化测试。

除了其核心模型类之外,服务器包还定义了用于表示 JSON 序列化模型的类。我想将这些序列化类以及可能的其他一些东西移动到客户端和服务器库都可以依赖的单独模块中。结构可能如下所示:

myapi
    server
        // core model
        // persistence back ends
        // HTTP controllers
        // etc.

    client
        // utilities for calling server endpoints

    ???
        // model classes for serialization. In general, there is a 1:1 mapping
        // between these classes and those in the core model, but there doesn't
        // have to be.

这应该不会太难,但我想知道是否有人知道在处理这种情况时要使用的任何约定。第三个模块应该命名为什么?虽然我专门询问命名建议,但也欢迎其他建议。

标签: mavenmoduledependency-management

解决方案


推荐阅读