API设计

如何设计APIs是一个相对比较复杂事情，目前比较常用的方式是CRUD和DDD，前者经常出现在各种代码生成器中，在初始化项目的时候生成增删改查接口，简单易用。比如对于更改用户信息，CRUD方式会生成一个 updateUserInfo(UserInfo userInfo)方法，调用该方法的时候只需传UserInfo参数即可，但问题在于，对于每次更新数据，服务消费者都需要提供完整的UserInfo信息，对于一些敏感信息（比如DTO中通常不会包含password信息）服务消费者并不能提供，其次，后台服务需要对业务数据做各种约束，如果单纯使用updateUserInfo方法会使得服务消费者可以随意地修改任何数据，这样会使后台服务失去意义，这个时候DDD原则更为适用，比如创建用户 POST api/user-info  修改用户基本信息 PUT api/user-info/base 修改密码 PUT api/user-info/password 用户删除 DELETE api/user-info/{userId} 用户激活 PUT api/user-info/active/{userId}等，这样设计的API职责分明，更加容易理解和重构。