首页
学习
活动
专区
圈层
工具
发布
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    REST API设计指导——译自Microsoft REST API Guidelines(一)

    前言 前面我们说了,有章可循,有据可依,有正确的产品流程和规范,我们的工作才不至于产生混乱,团队的工作才能更有成效。...如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...另外,REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...简单的来说,在REST API:URL定位资源,用HTTP动词(GET,POST,PUT,DELETE)描述操作。前面说了,REST 指的是一组架构约束条件和原则。...为什么用REST API? 1.前后端分离主要以API为界做接洽的,这样就会有很多的API,API的表现力更强,更加便于理解。

    1.8K30

    REST API设计指导——译自Microsoft REST API Guidelines(三)

    前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...5 Taxonomy 分类 As part of onboarding to Microsoft REST API Guidelines, services MUST comply with the taxonomy...Microsoft REST API 准则基本要求的一方面就是 服务的分类必须符合以下定义。...5.5 Long running API faults 长时间运行的API故障 For a Long Running API, it's possible for both the initial request

    1.7K30

    【Elasticsearch】Rest风格API

    Rest风格API Elasticsearch提供了Rest风格的API,即http请求接口 基本概念 Elasticsearch也是基于Lucene的全文检索库,本质也是存储数据,很多概念与MySQL...查看索引:get请求 get 索引库名 我们可以使用*来查询所有索引库 删除索引:delete请求 delete 索引库名 映射配置 创建索引库,就相当于mysql创建“数据库”。...但是有些字段是我们不希望被索引的,比如商品的图片信息,就需要手动设置index为false。 3)store 是否将数据进行额外存储。...czxy/book/b001 指定id查询,检索指定内容 GET czxy/book/b001?...": {}   } } 查询部分结果 GET czxy2/_search {   "query": {     "match_all": {}   },   "_source": ["username"

    1.7K40

    聊聊rest api设计

    序 本文主要研究下rest api的设计。 设计准则 easy to use & hard to misuse 易用不易误用,也就是api设计不要太复杂,要简单易用,而且还不能容易用错。...use case & document story api文档要围绕story或者use case来进行,在一个业务场景下提供完整的闭环操作。...防止文件下载目录遍历对于提供文件下载的接口,一定要避免目录遍历问题 服务质量保障 提供SLA 提供流量管理、熔断、限流 提供服务扩容机制 提供故障演练 提供审计功能 监控异常流量 提供调用方间的隔离 小结 rest...api的设计牵扯的方面比较多,本文暂时只是先列了一些,后续有待补充。...doc API设计要点 聊聊jpa的动态查询 使用RSQL实现端到端的动态查询

    1.3K10

    REST API 还是 GraphQL?

    前言 说到 API 设计,GraphQL 和 RESTful API 是当前最主流的两种选择,各自有其独特优势与挑战。...GraphQL 另外,相比 REST 的多次接口调用,GraphQL 支持聚合请求,有效减少 HTTP 请求次数。...RESTful API 优劣势 RESTful API 是目前最广泛使用的接口规范,基于 HTTP 协议,使用资源路径和请求方法组合完成数据操作。...它的设计清晰直观,GET/POST/PUT/DELETE 等操作语义明确。 增删改查,一目了然 而且生态成熟,社区和工具链完善,日志、监控、安全机制等配套方案多。...还有就是扩展性不如 GraphQL,对于需要动态字段、自定义响应结构的场景,REST 显得不够灵活! 最后 GraphQL 和 REST 各有千秋,关键在于选择适合自己团队和项目的方案。

    43610

    快速模拟 Rest API

    在前后端开发过程中,通常会通过 web api 进行沟通,Rest 风格和 JSON结构是常用的,例如前端要获取文章列表,需要通过 GET /post 来取得数据,返回的数据例如 { "posts"...: [ { "id": 1, "title": "test", "author": "me" }, ...... ] } 后端来定义路由和返回JSON数据 开发中,后端实现API的速度可能不能满足前端开发的速度...,前端为了不必等待后端,可以自己来模拟这个API,按照规定好的数据结构来返回模拟数据 json-server 就是用来实现这个需求的,不用自己写任何代码,把自己需要的模拟数据写入一个JSON文件,json-server...可以加载这个文件,并对外提供REST风格的访问方式,下面通过示例看具体的使用方式 先通过 npm 安装 json-server npm install -g json-server 然后自定义一个JSON...//localhost:3000/posts/1,只返回一条数据 { "id": 1, "title": "测试 json-server", "author": "dys" } 这是使用 GET

    2.4K40
    领券