REST API设计指导——译自Microsoft REST API Guidelines（四）

前言前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本.那么什么是好的API设计?这里我们不得不提到REST API. 关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容. 由于公众号文章内容字数有限,因此我们将翻译稿拆分并分享出来,并且给出英文对照.翻译的不对之处,请多多指教. 上篇内容: REST API设计指导——译自M…

REST API设计指导——译自Microsoft REST API Guidelines（二）

由于文章内容较长,只能拆开发布.翻译的不对之处,请多多指教. 另外:最近团队在做一些技术何架构的研究,视频教程只能争取周末多录制一点,同时预计在下周我们会展开一次直播活动,内容围绕容器技术这块. 所有章节我们翻译校对完成后,将会将最终定稿签入到我们的Github开源库托管,方便大家查阅和校正.同时,我们推荐将此规范作为团队的REST API设计指导和规范. 上篇内容: REST API设计指导——译自Microsoft REST API Guidelines(一) 3 Introduction…

REST API设计指导——译自Microsoft REST API Guidelines（三）

前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本.那么什么是好的API设计?这里我们不得不提到REST API. 关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容.由于公众号文章内容字数有限,因此我们将翻译稿拆分并分享出来,并且给出英文对照.翻译的不对之处,请多多指教. 另外,由于本周聚焦在架构层面,下周我们争取录制更多教程…

REST API设计指导——译自Microsoft REST API Guidelines（一）

前言前面我们说了,有章可循,有据可依,有正确的产品流程和规范,我们的工作才不至于产生混乱,团队的工作才能更有成效.我们经常见到,程序开发可能只用了半个月,但是接口的联调却经常需要花费半个月甚至一个月左右. 如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本.那么什么是好的API设计?这里我们不得不提到REST API. 另外,REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guid…

API设计指南(译)

API的设计在软件系统中的重要性不言而喻,在swift.org上看到一篇“API Design Guidelines”,虽然是就Swift而言,但对于其它语言也有不少可以借鉴的地方,在这里粗略翻译一二,作交流用途,比较随性,有些删改,如果需要看原文,请移步 https://swift.org/documentation/api-design-guidelines/ . API设计指南基本原则清晰,是第一要务.API方法和属性一处声明,到处调用,我们需要设计的使用起来简单明了.当我们评估一个…

Web API设计方法论--比较完整的web api 开发过程

为Web设计.实现和维护API不仅仅是一项挑战:对很多公司来说,这是一项势在必行的任务.本系列将带领读者走过一段旅程,从为API确定业务用例到设计方法论,解决实现难题,并从长远的角度看待在Web上维护公共API.沿途将会有对有影响力的人物的访谈,甚至还有API及相关主题的推荐阅读清单. 这篇 InfoQ文章是 Web API从开始到结束系列文章中的一篇.你可以在这里进行订阅,以便能在有新文章发布时收到通知. 设计Web API不止是URL.HTTP状态码.头信息和有效负载.设计的过程--基本上是…

关于REST API设计的文章整理

1. rest api uri设计的7个准则(1)uri末尾不需要出现斜杠/(2)在uri中使用斜杠/表达层级关系(3)在uri中可以使用连接符-提升可读性(4)在uri中不允许出现下划线字符_(5)在uri中优先使用小写字符(6)在uri中不允许出现文件扩展名,而应该使用content-type生命消息类型(7)在uri中使用复数形式详见:http://blog.restcase.com/7-rules-for-rest-api-uri-design/ 2. 5个rest api设计指导原则(…

API设计原则

译序 Qt的设计水准在业界很有口碑,一致.易于掌握和强大的API是Qt最著名的优点之一.此文既是Qt官网上的API设计指导准则,也是Qt在API设计上的实践总结.虽然Qt用的是C++,但其中设计原则和思考是具有普适性的(如果你对C++还不精通,可以忽略与C++强相关或是过于细节的部分,仍然可以学习或梳理关于API设计最有价值的内容).整个篇幅中有很多示例,是关于API设计一篇难得的好文章. 需要注意的是,这篇Wiki有一些内容并不完整,所以,可能会有一些阅读上的问题,我们对此做了一些相关的注释.…

移动App的REST API设计实践

原文:http://www.jianshu.com/p/23cccb3a90b1 通讯协议一些只是对服务器数据进行CRUD操作的App,通常采用HTTP协议,为了安全也可以采用HTTPS协议.IM软件可以选择使用XMPP协议. 其他一些特有场景的App可能基于Socket自定义协议. SOCKET是实现传输层协议的一种编程API,可以是TCP,也可以是UDP. TCP --- 传输控制协议,提供的是面向连接.可靠的字节流服务.TCP提供超时重发,丢弃重复数据,检验数据,流量控制等功能,保证数据…

Flink Program Guide （2） -- 综述（DataStream API编程指导 -- For Java）

v\:* {behavior:url(#default#VML);} o\:* {behavior:url(#default#VML);} w\:* {behavior:url(#default#VML);} .shape {behavior:url(#default#VML);} 张安张安 2 1 2016-08-02T10:56:00Z 2016-08-02T10:56:00Z 1 2945 16790 139 39 19696 16.00 false false false false…

API设计和命名

1.前言对于前端开发而言,肯定会和API打交道,大家也都会想过怎么设计自己的API.优秀的 API 之于代码,就如良好内涵对于每个人.好的 API 不但利于使用者理解,开发时也会事半功倍,后期维护更是顺风顺水.至于怎么设计API,今天就提下我自己的一些建议.如果大家有什么好的想法,欢迎指点. 2.命名良好的一个命名习惯,就是效率开发的第一步.如果命名规范,对自己而言,文件整理有很大的帮助,后期修改文件.可以快速的定位文件,命名规范,也显得自己专业.对团队而言,如果有统一的规范命名,交接时可以…

微服务指南走北（三）：Restful API 设计简述

API的定义取决于选择的IPC通信方式,假设是消息机制(如 AMQP 或者 STOMP).API则由消息频道(channel)和消息类型.假设是使用HTTP机制,则是基于请求/响应(调用http的url),这里我们先简述下RestfulAPI的定义. 设计原则域名应该尽量将API部署在专用域名之下,如: https://api.example.com 也能够放在主域名下: https://example.org/api/ 版本号放入到头信息的Accept中制定版本号并在版本号之间平缓过渡…

开发者必备——API设计问题

本文主要探讨RPC和RESTFul两种API风格的特点以及在开发中应该如何进行技术选型,同时截取了网上社区,文章一部分关于API设计的想法和观点供读者参考,取舍. 1,背景简述 API学名:应用程序接口(Application Programming Interface) 通俗的打个比方,人与人之间通过语言来交流,而程序和程序之间通过API来交流. 目前市场主流的API设计包括RPC,RESTFul,GraphQL等设计思路,关于API风格优劣,好坏众说纷纭,但客观来说:RPC资历最老,并沿用至…

RESTFUL如何指导WEB API设计？

博主刚刚接触web开发的时候,写了一个接口 /get_article_info/1 获取id为1的这篇文章的内容,被前辈们看见了,前辈给我说我这个接口设计的不太好啊,不符合RESTFUL规范,当前辈们说出这些话的时候,我很迷惑,我写的接口不能够好好工作吗?能够正常返回内容啊,对于不存在的文章也能够在返回的内容体中提示不存在,而且接口的意思很明确,一看就能明白,这还有什么不好的地方吗? 一.RESTFUL是什么? RESTFUL是英文单词Representational State Transfe…

HTTP API 设计指南（转）

add by zhj (2014-12-16): 今天才知道,原画HeroKu是国外一个很有名的PaaS提供商,公司很可能会将app迁移到他们那里英文原文: HTTP API Design Guide本文译者: LeoXu, Garfielt, 无若, --zxp 介绍本指南描述了一套有关 HTTP+JSON API 的设计实践, 原始内容提取自 Heroku 平台 API 的工作. 本指南是对API的补充,也是Heroku新的内部API的指南. 我们希望引起Heroku之外的API设计者的…

RESTful API设计原则与规范

RESTful API设计原则与规范一.背景与基础概念 2 二.RESTful API应遵循的原则 3 1.协议(Protocol) 3 2.域名(ROOT URL) 3 3.版本(Versioning) 3 4.路径(Endpoints) 3 5.HTTP动词(HTTP Verbs) 4 6.过滤信息(Filtering) 5 7.状态码(Status Codes) 5 8.错误处理(Error handling) 6 9.返回结果(Response) 6 10.使用HATEOAS的Hype…

Microsoft REST API指南

序言经过3个月的碎片时间的翻译和校验,由长沙.NET技术社区翻译的英文原文文档<Microsoft REST API指南>已经翻译完成,现刊载前十一章如下,欢迎大家点击"查看原文"按钮,查看指南的完整内容. PS:内容很长,全文读完大概需要耗时100分钟. Microsoft REST API指南工作组 Name Name Name Dave Campbell (CTO C+E) Rick Rashid (CTO ASG) John Shewchuk (Technical…

我所理解的RESTful Web API [设计篇]

<我所理解的RESTful Web API [Web标准篇]>Web服务已经成为了异质系统之间的互联与集成的主要手段,在过去一段不短的时间里,Web服务几乎清一水地采用SOAP来构建.构建REST风格的Web服务是最近两三年风行的潮流,所以很多人以为REST是一个事物.而事实却是:REST自其诞生之日起到现在(2014年)已经有14年了,它为什么叫这么一个"奇怪"的名字呢? 目录一.为什么叫这个"奇怪"的名字?二.采用URI标识资源二.采用URI标识…

来自HeroKu的HTTP API 设计指南(中文版)

原文转自:http://get.jobdeer.com/343.get 来自HeroKu的HTTP API 设计指南(中文版) 翻译 by @Easy 简介本指南中文翻译者为 @Easy ,他是国内首家互联网人才拍卖网站 JobDeer.com 的创始人.转载请保留本信息. 本指南描述了一系列 HTTP+JSON API 的设计实践, 来自并展开于 Heroku Platform API 的工作.本指南指导着Heroku内部API的开发,我们希望也能对Heroku以外的API设计者有所帮助.…

[Effective JavaScript 笔记]第6章：库和API设计--个人总结

前言又到了一章的总结,这章里的内容.是把我从一个代码的使用者,如何换位成一个代码的编写者.如何让别人用自己的代码更容易,不用去注意太多的无用细节,不用记住冗长的函数名.在使用API时怎样避免使用者会出现理解的偏差.如何处理一些特殊敏感的值,参数如何设置可以更好地自说明,如何减少API对状态的依赖,如何使API更加灵活,更利于用户的编写.下面一一展开介绍,对应的也会说明每条对应希望给到的是哪方面的建议! 第53条:保持一致的约定个人总结不要去创造一个独特的API,要使用一些大家惯用的词汇,参…

Web API 设计摘要

近期读了一本微电子书 Brian Mulloy 所著<Web API Design>感觉颇多收获,特对其内容做了个整理摘要以便回想其观点精华以指导日常工作中的设计思路. 本文主要讲述 Web API 设计,追求一种更务实的 REST 风格. 正如作者所说 REST 是一种架构风格,而非严格的标准,不是必需在形式定义上去做过多真论,究竟什么才是真正的 REST? 设计的目的是为了表达某样东西是怎样使用的,那么 API 设计的成功与否是由开发者是否可以高速上手并用的愉快. 以下讲述了 Web AP…

组件接口(API)设计指南－文件夹

组件接口(API)设计指南-文件夹组件接口(API)设计指南[1]-要考虑的问题组件接口(API)设计指南[2]-类接口(class interface) 组件接口(API)设计指南[3]-托付(delegate)和数据源协议(data-source protocols) 组件接口(API)设计指南[4]-通知(Notifications) 组件接口(API)设计指南[5]-最后的思考高速摘要: 译者注: 原文中"delegate"译为中文"托付/代理",含义…

[转] 阿里研究员谷朴：API 设计最佳实践的思考

API是软件系统的核心,而软件系统的复杂度Complexity是大规模软件系统能否成功最重要的因素.但复杂度Complexity并非某一个单独的问题能完全败坏的,而是在系统设计尤其是API设计层面很多很多小的设计考量一点点叠加起来的(也即John Ousterhout老爷子说的Complexity is incremental[8]).成功的系统不是有一些特别闪光的地方,而是设计时点点滴滴的努力积累起来的. 因此,这里我们试图思考并给出建议,一方面,什么样的API设计是__好__的设计?另一方面…

RESTful API 设计思考

RESTful API 设计思考,内容来源网络加自己的思考 1.RESTful Web API采用面向资源的架构:同一的接口,所以其成员体现为针对同一资源的操作2.SOAP Web API采用RPC风格:是一组相关功能的集合而已,CRUD的功能网络应用程序,分为前端和后端两个部分.当前的发展趋势,就是前端设备层出不穷(手机.平板.桌面电脑.其他专用设备......). 因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信.这导致API构架的流行,甚至出现"API First"…

RESTful API设计概要

一.简介 1. 什么是REST REST全称是Representational State Transfer,中文意思是表述(编者注:通常译为表征)性状态转移. 它首次出现在2000年Roy Fielding的博士论文中,Roy Fielding是HTTP规范的主要编写者之一. 他在论文中提到:“我这篇文章的写作目的,就是想在符合架构原理的前提下,理解和评估以网络为基础的应用软件的架构设计,得到一个功能强.性能好.适宜通信的架构.REST指的是一组架构约束条件和原则.” 如果一个架构符合REST…