V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
risky
V2EX  ›  程序员

请教关于 RESTFUL 风格 API 的设计

  •  
  •   risky · 2021-06-01 21:36:55 +08:00 · 1790 次点击
    这是一个创建于 1271 天前的主题,其中的信息可能已经有所发展或是发生改变。

    RESTFul 风格的 API 表现为操作资源, 如果返回的资源受到业务端口的不同或者权限的不同需要返回不同的内容该如何设计呢?

    目前只想到以下几种

    • 针对不同的业务端口以及权限使用带有不同的描述的资源的接口, 但是会增加接口的数量并且需要定义一套资源的描述方式
    • 使用相同的接口, 根据业务 /权限的不同来调整返回数据, 接口少了但是权限判断复杂, 而且接口文档难以讲明

    诸位还有什么更好的思路么......

    7 条回复    2021-06-02 10:34:17 +08:00
    join
        1
    join  
       2021-06-01 21:39:08 +08:00
    不能这么设计,权限和接口应该分开。在认证时确立好权限,然后实现接口时返回不同的数据。
    risky
        2
    risky  
    OP
       2021-06-01 21:48:52 +08:00
    @join 没太理解 "权限和接口应该分开" 是什么意思, 目前想的认证方式是 jwt 首次登录的时候, 权限字段封装在 jwt 里请求接口的时候判断权限, 纠结的点是应该是通过一个接口不同权限返回不同数据, 还是多个接口, 不同权限调用不同的接口......
    no1xsyzy
        3
    no1xsyzy  
       2021-06-01 22:05:54 +08:00
    权限应当只决定一件事:这个接口是否允许被调用。
    我怀疑你的资源粒度还不够细。
    join
        4
    join  
       2021-06-01 22:26:05 +08:00
    @risky 你要是这么设计会被锤的。
    接口尽量简洁,朴实无华且枯燥。你见过谁的 restful 是这样设计的?设计 restful 的第一原则就是别搞创新。
    IvanLi127
        5
    IvanLi127  
       2021-06-01 23:10:12 +08:00 via Android
    判断权限复杂的话 你分接口就不复杂了吗(;` O´)o 应该有优化空间吧
    Jooooooooo
        6
    Jooooooooo  
       2021-06-01 23:13:25 +08:00
    api 接口设计第一原则, 命名尽量清晰, 不查文档就知道是干嘛的

    剩下的随意, 比如全是 post 接口也没事, 不靠这个
    xuanbg
        7
    xuanbg  
       2021-06-02 10:34:17 +08:00
    @Jooooooooo restful 原教旨主义者即将到达……
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   968 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 23ms · UTC 20:17 · PVG 04:17 · LAX 12:17 · JFK 15:17
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.