API文档规划疑问:/me端点应放独立页面还是对应项目页?
API文档中/me端点的组织方案建议
方案1:集中到单独的「Profile」页面
- 好处:能清晰把全局用户专属入口和通用资源端点分开,强化
/todos这类基础端点的“核心资源操作”定位,不会让用户把通用资源和个人专属资源搞混;所有用户相关的端点放在一起,想找个人权限内的操作时能快速定位。 - 坏处:用户看某个资源(比如todos)的完整操作时,得在两个页面跳来跳去,打断浏览的连贯性。
方案2:归入对应资源的项目页面
- 好处:同一资源的所有操作(通用+个人专属)都在一个页面,符合用户“找todos操作就去Todos页”的直觉,导航更顺;还能直观对比通用端点和个人端点的差异(比如
GET /todos返回全量,GET /me/todos只返回当前用户的),理解起来更简单。 - 坏处:可能会让基础端点的“核心”感变弱,页面内容也会稍微杂一点。
给你的方向建议
如果你的API核心是围绕资源展开(比如主要做todos、posts这类资源的操作),优先选方案2,同时可以用小技巧弥补劣势:
- 在资源页面里用二级标题明确区分「通用资源操作」和「个人专属资源操作」,比如Todos页里:
通用Todos操作
GET /todos:返回数据库中所有todos(核心端点)- ...其他通用端点
当前用户Todos操作
GET /me/todos:返回当前用户的所有todos
- 给基础端点加醒目标注,比如用加粗突出
**GET /todos**,或者在旁边标注「核心」字样。
如果你的API里用户专属操作占比高,或者想突出以用户为中心的设计,就选方案1,同时在每个资源页面的末尾加个提示:
想要查看当前用户专属的todos操作,请前往Profile页面
内容的提问来源于stack exchange,提问作者Tom687
相关产品推荐
相关产品推荐

