优秀api鉴赏

http://codeplanet.io/principles-good-restful-api-design/

hateoas

http://en.wikipedia.org/wiki/HATEOAS

http://en.wikipedia.org/wiki/RSDL

http://www.doc88.com/p-1367381447735.html

if match

if none match

google restful api design

http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api#snake-vs-camel

https://stripe.com/docs/api#charge_object

https://developer.github.com/v3/gists/#list-gists

url: v + n(s) + (phase)

adj

queryString: ?state=adj&order=property&query=cond

queryString:(POST) 真正请求的参数

list/financePlan?status=investable&order=openDate&query=status:open

list/financePlan/repay?

list/financePlan/5/repay?是否能识别?

detail/loanInvestor/5?state=invested.....

invest/loan/125?state=...

add/user/before

add/user

add/user/after

v:

do

add

update

delete

list

detail

invest

status :

investable, investing, invested

redeemable, redeeming, redeemed

phase:

before,after

优秀api鉴赏

时间: 2024-11-05 15:45:07

优秀api鉴赏的相关文章

优秀API设计的十大原则

优秀API设计的十大原则 2015-09-23    分类:编程开发.设计模式.首页精华暂无人评论 分享到:更多4 二十万年薪PHP工程师培养计划 成为被疯抢的Android牛人 风中叶讲Java重难点 Linux运维基础课程 本文由码农网 – 小峰原创翻译,转载请看清文末的转载要求,欢迎加入技术翻译小组! 每个软件开发人员都使用API.“优秀”的API设计就像魔法.不过,我不知道有多少人可以解释为什么有的API很复杂.很难学,而有的则干净.简单.使用起来堪称是一种快乐.关于这个问题,我将在文中

前阿里P8架构师谈如何设计优秀的API

随着大数据.公共平台等互联网技术的日益成熟,API接口的重要性日益凸显,从公司的角度来看,API可以算作是公司一笔巨大的资产,公共API可以捕获用户.为公司做出许多贡献.对于个人来说,只要你编程,你就是一个API设计者,因为好的代码即是模块--每个模块便是一个API,而好的模块会被多次使用.此外,编写API还有利于开发者提高代码质量,提高自身的编码水平. 优秀API所具备的特征: 简单易学: 易于使用,即使没有文档: 很难误用: 易于阅读,代码易于维护: 足够强大,可以满足需求: 易于扩展: 适

从涂鸦到发布——理解API的设计过程(转)

英文原文:From Doodles to Delivery: An API Design Process 要想设计出可以正常运行的Web API,对基于web的应用的基本理解是一个良好的基础.但如果你的目标是创建出优秀的API,那么仅凭这一点还远远不够.设计优秀的API是一个艰难的过程,如果它恰巧是你当前的工作任务,那么你很可能会感到手足无措. 不过,优秀的设计绝对是可以实现的.本文所描述的流程将帮助你获得成功,我们将共同研究什么是优秀的设计,以及迭代式的流程如何帮助我们实现这一目标.我们还将叙

程序员如何编写好开发技术文档 如何编写优质的API文档工作

编写技术文档,是令众多开发者望而生畏的任务之一.它本身是一件费时费力才能做好的工作.可是大多数时候,人们却总是想抄抄捷径,这样做的结果往往非常令人遗憾的,因为优质的技术文档是决定你的项目是否引人关注的重要因素.无论开源产品或面向开发者的产品,均是如此. 实际上,我想说明的是:对于面向开发者的产品来说,其用户体验中最重要的一环并不是什么主页设计.登录过程.或者SDK下载.真正最重要的是产品的API文档!如果没人知道你的产品如何使用,纵使它巧夺天工,又有何用? 如果你是一个专门从事面向开发者产品设计

准备开发开放API接口

准备开发APP开放接口,允许JQUERY直接调用http://blog.csdn.net/wuxiangege/article/details/52238968 SIGN的设计与实现http://blog.csdn.net/fengshizty/article/details/48754609 优秀API设计的十大原则 https://wenku.baidu.com/view/7ec95d53102de2bd970588be.html

atitit.api设计 方法 指南 手册 v2 q929.docx

atitit.api设计 方法 指南 手册 v2 q929.docx atitit.api设计原则与方法 1. 归一化(锤子钉子理论)1 1.1. 链式方法2 1.2. 规则5:建立返回值类型2 1.3. 参数接收 JSON 对象2 1.4. 参数默认值2 1.5. 命名参数 support by map2 1.6.  处理类型 类型自动转换4 1.7.  处理 undefined null  empty5 1.8. .使用结构化语法5 1.9. 设置和获取操作,可以合二为一:方法越多,文档可能

APIs — A Strategy Guide】系列之二 把API作为你的商业策略

翻译/张志高 如果你身处技术界, 你不会怀疑API对业务的显著影响,否则,可能有点难以理解为什么API会跟你的业务有关系. 在商业领域API每天都在快速增长,本章节的论点应该能帮助不在科技界的人了解API的重要性,同时提供一些论据使其相信采用API策略的价值. 今天,API消费模式正在急剧增长,为什么呢,主要是应用程序和移动设备快速增长.根据De Beer的估计判断,在2020年,应用程序和连接设备正迅速从十亿级增长至万亿级别.很多公司都发现他们的客户正快速抛弃基于浏览器的web应用.如果你想继

从商业角度探讨API设计

为Web设计.实现和维护API不仅仅是一项挑战:对很多公司来说,这是一项势在必行的任务.本系列将带领读者走过一段旅程,从为API确定业务用例到设计方法论,解决实现难题,并从长远的角度看待在Web上维护公共API.沿途将会有对有影响力的人物的访谈,甚至还有API及相关主题的推荐阅读清单. 如今,API已经成为了每个重要信息技术趋势的核心内容.移动设计.云计算.物联网.大数据及社交网络等应用都依赖于一个基于web的界面与它们的分布式组件进行连接,为全球范围内的各个商业领域提供具有创新性和颠覆性的解决

编写 Node.js Rest API 的 10 个最佳实践

Node.js 除了用来编写 WEB 应用之外,还可以用来编写 API 服务,我们在本文中会介绍编写 Node.js Rest API 的最佳实践,包括如何命名路由.进行认证和测试等话题,内容摘要如下: 正确使用 HTTP Method 和路由 正确的使用 HTTP 状态码 使用 HTTP Header 来发送元数据 为 REST API 挑选合适的框架 要对 API 进行黑盒测试 使用基于 JWT 的无状态的认证机制 学会使用条件请求机制 拥抱接口调用频率限制(Rate-Limiting) 编