ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

1. 遵守RESTful API 规范

2022-05-07 10:34:39  阅读:164  来源: 互联网

标签:API com api products 遵守 https RESTful example


RESTful API

  • 域名
    应该尽量将API部署在专用域名之下

    https://api.example.com
    

    如果确定API很简单,不会有进一步的扩展,可以考虑放在主域名下

    https://example.com/api/
    
  • 协议
    推荐用 HTTPS

  • 版本
    应该将API的版本号放入URL

    https://api.example.com/v1.0/apples/
    https://api.example.com/v1.1/apples/
    https://api.example.com/v2.0/apples/
    
  • 路径
    推荐用名词+复数
    对于一个简洁结构,你应该始终用名词。此外,利用的HTTP方法可以分离网址中的资源名称的操作。

    GET      /products    :将返回所有的产品清单
    POST     /products    :将产品新建到集合
    GET      /products/4  :将获取产品4
    PATCH    /products/4  :将更新产品4 (部分属性更新)
    PUT      /products/4  :将更新产品4 (全部属性更新)
    DELETE   /products/4  :将删除产品4
    
  • HTTP动词

    请求方法 请求地址 后端操作
    GET /students 获取所有学生

标签:API,com,api,products,遵守,https,RESTful,example
来源: https://www.cnblogs.com/liuyz7975/p/16241424.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有