V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
stillsilly
V2EX  ›  问与答

请教一下 api 命名的问题

  •  
  •   stillsilly · 2019-01-31 12:53:15 +08:00 · 1528 次点击
    这是一个创建于 2152 天前的主题,其中的信息可能已经有所发展或是发生改变。
    评论文章接口
    叫 /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   ·   实用小工具   ·   841 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 21:05 · PVG 05:05 · LAX 13:05 · JFK 16:05
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.