如何设计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职责分明，更加容易理解和重构。
API设计
©著作权归作者所有,转载或内容合作请联系作者
- 文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
- 文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
- 文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
推荐阅读更多精彩内容
- 前面两篇内容（RESTful Web Service 架构剖析和HTTP Methods 和 RESTful Se...
- 转至：http://cizixs.com/2016/12/12/restful-api-design-guide ...
- API 可以说是软件开发者的用户界面，API 设计也是系统架构的重要环节。尤其对复杂和分布式系统而言，其设计的好坏...
