前后端 页面 url 与 api url 如何统一命名风格.

查看 60|回复 2
作者:dnjat   

  • 打算把页面 url,与 api url 做一个风格统一,查了许多大佬的文章和分析,最后常用的有 rest,rpc 风格,因为才接触这些风格,恐未掌握其精髓,所以下面定义用了似 rest 风格.希望得到大家的建议与使用经验,哪种风格更适合监控,更加适合应付生产线上碰到的一些 url 问题.

  • rest,用 get,post,put,delete 来定义动作,围着一个地址,好处,简洁.但多语义比较乏力.

  • rpc, 完全用 url 定义作用.

    前端页面
    [td]url[/td]
    [td]-[/td]
    /content/{id:123}
    内容详细页
    /contents?order=create_time,desc
    内容列表页
    /contents/query?create_time=2023/09/01,2023/10/01
    搜索
    /content/{id:123}/edi
    内容编辑页
    /content/create
    内空创建
    /content/edit?id=123
    创建编辑页为同一个页面
    供前端调用 api - 似 rpc 风格
    [td]method[/td]
    [td]url[/td]
    [td]-[/td]
    get
    /content/get
    单条详细,
    get
    /content/lists?order=file,desc
    列表
    get
    /content/query?type=best
    查询
    post
    /content/create
    新建
    post
    /content/update
    更新
    post
    /content/delete
    删除
    post
    /content/favorite
    收藏
    供前端调用 api - 似 rest 风格
    [td]method[/td]
    [td]url[/td]
    [td]-[/td]
    get
    /contents/{id:123}
    单条详细
    get
    /contents?order=file,desc
    列表
    get
    /contents/query?type=best
    查询
    post
    /contents
    新建
    put
    /contents/{id:123}
    更新
    delete
    /contents/{id:123}
    删除
    post
    /contents/{id:123}/favorite
    收藏

    content, contents, url, post

  • xiang0818   
    这个其实无所谓。只是要记得在使用幂等 method 的时候,nginx 默认会超时重试。。。
    caisanli   
    可以在 API 前加个前缀,避免在 history 模式下前端路由和 API 地址冲突。
    您需要登录后才可以回帖 登录 | 立即注册

    返回顶部