首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    HTTP API 设计指南HTTP API 设计指南

    HTTP API 设计指南 前言 这篇指南介绍描述了 HTTP+JSON API 的一种设计模式,最初摘录整理自 Heroku 平台的 API 设计指引 Heroku 平台 API 指引。...这篇指南除了详细介绍现有的 API 外,Heroku 将来新加入的内部 API 也会符合这种设计模式,我们希望非 Heroku 员工的API设计者也能感兴趣。...我们的目标是保持一致性,专注业务逻辑同时避免过度设计。我们一直试图找出一种良好的、一致的、显而易见的 API 设计方法,而并不是所谓的"最终/理想模式"。...我们假设你熟悉基本的 HTTP+JSON API 设计方法,所以本篇指南并不包含所有的 API 设计基础。...强制头信息 Accept 中提供版本号 制定版本并在版本之间平缓过渡对于设计和维护一套API是个巨大的挑战。所以,最好在设计之初就使用一些方法来预防可能会遇到的问题。

    2.4K31

    API如何设计

    在之前《应对变化》[1]中提到模块之间合的策略:缩小依赖范围,API是两个模块间唯一的联结点 ? 怎么才是一个好的API设计呢?...设计成: systemB.receive(long userId,String username,Object data); 一切都是行云流水,大家都很happy,如期发布上线 爱情总是在转角处遇到,上线完...系统A:太麻烦了,你自己取了,想怎么控制就怎么控制 系统B:你是不爱我了 系统A:你怎么就不理解我呢 ---- 温习一下一个好的API设计要求: 缩小依赖范围,就是要精简APIAPI要稳定得站在需求角度...因为任何一项知识的变化都会导致双方变化2.API也要高内聚,不应强迫API的客户依赖不需要的东西3.站在what角度;而不是how,怎么技术实现的角度 上面示例的问题就在系统B接受数据api: systemB.receive...,但回头复盘,发现了很多理论缺乏,惯性思维使然造成的不合理,难维护,难扩展的设计 由此看出,日常的CRUD并不是没有技术含量,而是我们有没有深刻认知 References [1] 《应对变化》: http

    55110

    API Gateway 设计

    1.1 什么是API网关 API网关可以看做系统与外界联通的入口,我们可以在网关进行处理一些非业务逻辑的逻辑,比如权限验证,监控,缓存,请求路由等等。...1.2 为什么需要API网关 RPC协议转成HTTP。...1.3 统一API网关 统一的API网关不仅有API网关的所有的特点,还有下面几个好处: 统一技术组件升级 在公司中如果有某个技术组件需要升级,那么是需要和每个业务线沟通,通常几个月都搞不定。...在Netflix Zuul中也应用了这种模式,如下图所示: image 这种模式在网关的设计中我们可以借鉴到自己的网关设计: preFilters:前置过滤器,用来处理一些公共的业务,比如统一鉴权,统一限流...1.基本流控:基于API的QPS做限流。2.运营流控:支持APP流量包,APP+API+USER的流控33.大促流控:APP访问API的权重流控。

    48100

    Zend API:深入 PHP 内核

    Zend API:深入 PHP 内核 译序及目录 译序 网上关于 PHP 的资料多如牛毛,关于其核心 Zend Engine 的却少之又少。...另外一个选择就是将其作为一个整体,一次性的讲述所有的这些操作、设计、技巧和诀窍等,并且可以让我们在实际动手前就可以得到一副完整的愿景。...如今的 Zend API 已经承担了很多原来(指的是分离之前)本属于 PHP API 的职责,大量的 PHP API 被以别名的方式简化为对应的 Zend API。...我们推荐您应该尽可能地使用 Zend APIPHP API 只是因为兼容性原因才被保留下来。...(十六)调用用户函数 PHP 还允许你在你的模块里面调用一些一些用户定义的函数,这样在实现某些回调机制(比如在做一些数组的轮循(array walking)、搜索或设计一些简单的事件驱动的程序时)时会很方便

    2.6K20

    PHPAPI讲解(一)

    1、了解api   在使用与创建自己的API之前我们需要先了解什么是API!   API代表应用程序编程接口,而接口指的是一个特定的服务、一个应用程序或者其他程序的公共模块。   ...(备注:在学习API的时候看过的两本有关API的书籍都有提到这个SOA,但是由于自己还是个菜鸟所以对这个理解不太深。...所以对于以上SOA的含义摘抄于PHP精粹-编写高效PHP代码(美))   在使用api是涉及到一个重要的问题是传输的数据格式:在API数据传输中主要使用XML与Json数据格式。...在很多语言中包括PHP都有内置的类库,可以很容易就可以处理SOAP,创建与使用SOAP服务。   REST:REST不是一个协议,它没有严格定义的接口与数据格式,更像一套设计原则。...3、各种服务的简单实例 PHP与SOAP   简单介绍:   PHP中含有SOAP扩展这样方便我们建立与使用SOAP类型的API

    1.3K30

    php设计模式

    设计模式是熟练运用OOP后自然而然形成的代码习惯。达到最高境后只有一句话:高内聚、低耦合。 php中的设计模式 想要成为一名高级程序员,设计模式是必须完全掌握的。...我们经常看到关于java,c#设计模式的讲解,却很少看到用php代码讲解设计模式的, 这是为什么呢。...php本身是一种面向过程编程的的语言,PHP 5中借鉴了java的一些特性开始对面向对象支持更加完善,设计模式也可以用与php中了,但是现在关于php面向对象编程的资料很少,对很多phper进阶高级程序员造成很大障碍...,所以我打算写一系列设计模式的文章,一来是对自己的一种提高,二来希望能帮助到那些像我一样没有其他语言基础,php作为的入门语言的程序员。...学习设计模式之前希望大家能已经熟练掌握了php的一些高级特性,比如命名空间,链式调用,类的自动载入。 1.工厂模式 工厂模式是用工厂方法生成对象,而不是直接new一个对象。

    1.2K90

    REST API 设计最佳实践:如何构建、设计和使用 API

    但是,我主要接触的是REST,这是一种基于资源的API和Web服务开发架构风格。在我的职业生涯中有很大一部分时间都参与了构建、设计和使用API 的项目。...因此我决定写篇文章分享一下,在设计 REST API 时的最佳实践。以下是关于设计优秀REST API 的一些建议、提示和指导,帮助您让消费者(以及开发人员)满意。 1....学习 HTTP 基础知识 如果你想构建一个设计良好的REST API,那么你必须了解HTTP协议的基本知识。我坚信这将帮助你做出正确的设计选择。...Mozilla Developer Network文档上关于HTTP概述是一个相当全面的参考资料,尽管如此,在REST API设计方面,以下是将HTTP应用于RESTful设计的简要说明: HTTP具有动词...这种设计真的很糟糕,因为它破坏了API与其使用者之间的信任关系,你会担心API可能在欺骗你。所有这些都极不符合RESTful风格。那么你应该怎么做呢?

    42140

    API 设计评审已死,API 设计评审万岁

    更为重要的是,在大部分开发工作完成之前便确定 API 设计,可以在很大程度上避免在最后一刻才发现问题,从而影响交付时间(通常被称作是 设计优先方法)。...提前做好这些功课可以避免在 API 设计的过程中因命名而产生冲突。与相关的利益相关者一同定义每个领域中的共通术语,确保 API 设计的广泛使用和了解。...在组织上下设立 API 设计审查员 虽然应设置一个 API 启用的团队负责策划这些设计标准并促进社区的发展,但也应在每个功能区或领域中启用权威。...实施 API 设计审查 在达成上述的先决条件后,API 设计审核也就基本完成了。对领域驱动的中小企业而言,设计审查通常可被整合到进行中的设计工作内。...更重要的是密切关注 API 设计审查的周期。随着时间的推移,更多去中心化的中小企业将对现有标准和新标准的采用更加熟悉,API 设计审查频率也应明显地下降。

    15920
    领券