请教一下 api 命名的问题 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
stillsilly
V2EX    问与答

请教一下 api 命名的问题

  •  
  •   stillsilly 2019-01-31 12:53:15 +08:00 1878 次点击
    这是一个创建于 2454 天前的主题,其中的信息可能已经有所发展或是发生改变。
    评论文章接口
    叫 /api/comment/create 参数 articleId,content
    还是 /api/article/comment 参数 id,content
    哪个好? 或者两个都不好,有什么其他更好的写法吗?

    还有获取文章的评论列表
    /api/comment/getList 参数 articleId
    /api/article/comments 参数 id


    似乎没有什么书专门说 api 命名的事,有什么质量高点的博客之类的资料可以看看吗

    ------------------更新一下-------------------
    刚刚在淘宝看到两本书《 Web API 的设计与开发》《 RESTful Web APIs 》,有看过这两本书的吗 感觉咋样?
    还有其他什么书可以推荐一下吗?
    9 条回复    2019-01-31 19:26:42 +08:00
    DavidNineRoc
        1
    DavidNineRoc  
       2019-01-31 13:02:31 +08:00   2
    多看一下 RESTFul 的文章,
    文章的评论结构,既然是该文章下的,那么就应该从 url 中看的出来
    如:
    /api/v1/articles/{article}/comments => post: 新建 get: 获取列表
    /api/v1/articles/{article}/comments/{comment} => delete: 删除评论
    GDC
        2
    GDC  
       2019-01-31 13:11:09 +08:00 via iPhone   1
    个人觉得 RESTful 挺恶心的,把很多问题搞复杂了。而且 RESTful 只是一种推荐风格,也不是什么标准。
    luotian
        3
    luotian  
       2019-01-31 13:14:40 +08:00   1
    stillsilly
        4
    stillsilly  
    OP
       2019-01-31 13:17:14 +08:00
    @DavidNineRoc 谢谢
    我不想用 method 表示操作类型咋么办
    不知道为什么,我们公司所有人所有项目,全部统一用的 post,我也被他们传染了,感觉这样还挺方便 前后端沟通接口从来不说请求类型,也不会因为不小心弄错类型拿不到数据……
    这样做有什么不好的地方吗……
    jonahtan
        5
    jonahtan  
       2019-01-31 13:27:46 +08:00   2
    /api/v1.0/articles/comments/{id}/{do}

    /api/版本号 /业务域 /服务 /编号索引 /操作项
    namesc
        6
    namesc  
       2019-01-31 13:29:29 +08:00   1
    我觉得 RESTful API 挺繁琐的,不喜欢,它是一种公开约定,其实就是建议。

    不一定要用这个,使用这个规范的不多,阿里云腾讯云那些有海量 API 的产品也没用这个规范。
    stillsilly
        7
    stillsilly  
    OP
       2019-01-31 13:32:09 +08:00
    lynskylate
        8
    lynskylate  
       2019-01-31 13:34:00 +08:00 via Android   1
    对于文章这种资源 restful 是非常合适的
    wc951
        9
    wc951  
       2019-01-31 19:26:42 +08:00   1
    你可以看下 github 的 api 是怎么设计的,那个是很标准的 restful 风格,而且是使用了成熟度最高的 HATEOAS 模型
    关于     帮助文档     自助推广系统     博客     API     FAQ     Solana     4860 人在线   最高记录 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 34ms UTC 03:58 PVG 11:58 LAX 20:58 JFK 23:58
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86