API设计中响应数据格式用json的优点

通常我们再设计api返回时,都使用json格式返回,相比xml,他又有什么优点呢? 更直观易懂占用空间更小能与JavaScript跟好的兼容.js通过eval()进行Json读取. 支持多种语言. 总的来说遵循了易用便于传播的原则,假如出现更易用的数据格式,json也会慢慢被取代.…

api的设计涉及到的方面很多, 分类是一个基本的思考方式.如果可以形成一个系列性的文字,那就从性能开始吧. 就像任何性能一样,API 性能主要取决于如何响应不同类型的请求.例如:典型的电商场景,显示用户当前的订单.应用程序从一个 API 获取订单详情.但是,如果希望用户在一个地方能查看他们所有的订单,这意味着,我们的 API 现在将返回比以前更多的数据,后台的负载会更大.如何确保我API 能够将所有数据返回给用户,而不会出现延迟.服务器错误和过多请求等问题呢? 一般地, 如何在API设计中提升性…

在Java API设计中，面向接口编程的思想，以及接口和工厂的关系

现在的java API的设计中,提倡面向接口的编程,即在API的设计中,参数的传递和返回建议使用接口,而不是具体的实现类,如一个方法的输入参数类型应该使用Map接口,而不是HashMap或Hashtable等具体的实现类.这样做的好处是,程序容易扩展.如果使用Map作为参数,用户可以使用任何实现Map接口的类作为参数,而不是仅仅限制使用HashMap或Hashtable作为参数,使程序的实现更加灵活. 接口(Java的Interface),只定义了一些抽象的方法(也可以定义一些常量,但不鼓励这么…

API设计中防重放攻击

HTTPS数据加密是否可以防止重放攻击? 否,加密可以有效防止明文数据被监听,但是却防止不了重放攻击. 防重放机制我们在设计接口的时候,最怕一个接口被用户截取用于重放攻击.重放攻击是什么呢?就是把你的请求原封不动地再发送一次,两次...n次,一般正常的请求都会通过验证进入到正常逻辑中,如果这个正常逻辑是插入数据库操作,那么一旦插入数据库的语句写的不好,就有可能出现多条重复的数据.一旦是比较慢的查询操作,就可能导致数据库堵住等情况.付款接口,或者购买接口会造成损失需要采用防重放的机制来做请求验证…

Go语言中的数据格式（json、xml 、msgpack、protobuf）

在分布式的系统中,因为涉及到数据的传输,所以一定会进行数据的交换,此时就要定义数据交换的格式,例如二进制.Json.Xml等等.本篇文章就是总结一下常用的几种数据格式. 一.Json格式如果想使用Json数据格式,可以借助于encoding/json这个包. 利用json包里的 json.Marshal(xxx) 和 json.Unmarshal(data, &xxx) 进行序列化和反序列化. 下面举个例子: package main import ( "encoding/json&q…

restful api设计中的幂等性的理解。

以前就听说过这个词,但是最近看了一些文章,产生了一些疑惑, GET是幂等性.例如查一条数据,如果你给定一个id.那么你查多少次.都是这条数据,但是我疑问,这里的幂等性指的是,每次都返回一条.这个数量,还是说每次都返回同样一条数据(数据内容) DELETE是幂等性你第一次删除数据,是删除掉.这个副作用是删除了给定id的数据,服务端数据状态发生了改变.但是你二次再删除,数据是没有的,你没删除掉.这里的幂等性如何理解,状态的改变是相对于谁的改变看了这篇文章 http://www.oschina.n…

什么是好的 API 设计？【eolink翻译】

对于试图完善其 API 策略的团队来说,良好的 API 设计是一个经常出现的话题. API 设计的重要性相信不需要赘述,精心设计的 API 的好处包括:更好开发人员体验.更快的文档编制以及更高的 API 使用率. 那么好的API设计到底是什么?这篇文章将详细介绍一些设计 RESTful API 的最佳实践. | 精心设计的 API 的特征一般来说,一个有效的 API 设计将具有以下特点: *** 易于阅读和使用.**一个设计良好的 API 通常都易于使用,并且它的资源和相关操作可以被不断使用它…

出色的 JavaScript API 设计秘诀

设计是一个很普遍的概念,一般是可以理解为为即将做的某件事先形成一个计划或框架. (牛津英语词典)中,设计是一种将艺术,体系,硬件或者更多的东西编织到一块的主线.软件设计,特别是作为软件设计的次类的API设计,也是一样的.但是API设计常常很少关注软件发展,因为为其他程序员写代码的重要性要次于应用UI设计和最终用户体验. 但是API设计,作为我们自己写的库中提供的公共接口,能够向调用我们代码的开发者表现出我们库的一些特点和功能,所以API设计和UI设计一样重要.事实上,两者都是为应用可以提供更好的…

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

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

HTTP Methods 和 RESTful Service API 设计

含义: HTTP Methods:也叫 HTTP Verbs,HTTP Methods 可以翻译成 HTTP 方法.它们是 HTTP 协议的一部分,主要规定了 HTTP 如何请求和操作服务器上的资源,常见的有GET,POST等. API:Application Programming Interface 应用程序接口,RESTful API,这类API是通过 HTTP 协议 URL 形式暴露给其它系统或者模块调用,比如,一个获得用户所有评论的 API 可能像这样:https://api.serv…

API设计原则

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

好的框架需要好的 API 设计 —— API 设计的六个原则

说到框架设计,打心底都会觉得很大很宽泛,而 API 设计是框架设计中的重要组成部分.相比于有很多大佬都认可的面向对象的六大原则.23 种常见的设计模式来说,API 设计确实缺少行业公认的原则或者说设计范式. 不过,没有公认不代表没有.无论是对外提供类库还是提供 url 形式的 API,为了使用者良好的使用体验,依然也是有可以借鉴和参考的经验的. 本文使用多种语言编写,请选择你喜欢的语言: 中文: 好的框架需要好的 API 设计 —— API 设计的六个原则 - walterlv Englis…

API 设计 POSIX File API

小结: 1. https://mp.weixin.qq.com/s/qWrSyzJ54YEw8sLCxAEKlA API 设计最佳实践的思考谷朴阿里技术昨天阿里妹导读:API 是模块或者子系统之间交互的接口定义.好的系统架构离不开好的 API 设计,而一个设计不够完善的 API 则注定会导致系统的后续发展和维护非常困难. 接下来,阿里巴巴研究员谷朴将给出建议,什么样的 API 设计是好的设计?好的设计该如何做? 作者简介:张瓅玶 (谷朴),阿里巴巴研究员,负责阿里云容器平台集群管理团…

[译] 在Web API 2 中实现带JSON的Patch请求

原文链接:The Patch Verb in Web API 2 with JSON 我想在.NET4.6 Web API 2 项目中使用Patch更新一个大对象中的某个字断,这才意识到我以前都没有用过Patch.这是一次难得的学习机会. 我不知道在Web API 2中最好的实现方式是什么,所以我按照惯例,用google搜索"Patch Web API".我得到的第一条结果是Michael McKenna's "How to Add JSON Patch Support to…

HTTP API 设计指南（响应部分）

前言这篇指南介绍描述了 HTTP+JSON API 的一种设计模式,最初摘录整理自 Heroku 平台的 API 设计指引 Heroku 平台 API 指引. 这篇指南除了详细介绍现有的 API 外,Heroku 将来新加入的内部 API 也会符合这种设计模式,我们希望非 Heroku 员工的API设计者也能感兴趣. 我们的目标是保持一致性,专注业务逻辑同时避免过度设计.我们一直试图找出一种良好的.一致的.显而易见的 API 设计方法,而并不是所谓的"最终/理想模式". 我们假设你熟…

天气API整理，返回的数据格式为json对象

中国天气的API惨遭封杀,不得已更换其他的API使用吧. 这里大部分API来自APP的数据包截取或者反汇编,所以各开发使用者不得用于商业用途,否则后果自负! 1.金山网址导航来源:http://www.duba.com/tianqiyubao.html API地址:http://weather.123.duba.net/static/weather_info/101010100.html 数据格式:JSON 数据包含:PM2.5,7天天气详细数据等 DEMO: weather_callback…

前端响应式设计中@media等的相关运用

现在做前端响应式网站特别,响应式成为现在前端设计一个热点,它成为热点的最主要的原因就是,移动端设备屏幕的种类多样,那么如何设置响应式屏幕. /*打印样式*/ @mediaprint{color:red;} /*手机等小屏幕手持设备*/ @mediascreenand(min-width:320px)and(max-width:480px){body{background:yellow;}} /*平板之类的宽度1024以下设备*/ @mediaonlyscreenand(min-width:321…

SpringMVC从Control中响应json数据

在页面上异步获取Controller中响应的json数据. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR…

API 接口设计中 Token 类型的分类与设计

在实际的网站设计中我们经常会遇到用户数据的验证和加密的问题,如果实现单点,如果保证数据准确,如何放着重放,如何防止CSRF等等其中,在所有的服务设计中,都不可避免的涉及到Token的设计. 目前,基于Token的生成方,我们把Token生成分为两种类型. 1.基于用户/网站,可见的加密请求方式 2.基于服务器间通讯的不可见加密请求方式(API Token) 其中,网页/APP访问又分为登录态和非登录态两种请求区别. (非登录态请求要求用户访问页面时会随机生成唯一且有时效性的token,该t…

移动互联网实战--Web Restful API设计和基础架构

前言: 在移动互联网的大潮中, Web Restful API逐渐成为Web Server重要的一个分支. 移动端和服务端的交互, 主流的方式还是通过Http协议的形式来进行. 请求以Get/Post方式, 响应以json(数据更小巧且自描述能力强)的方式占据主流. 各大互联网公司, 对自身的Web Api设计有各自的标准. 本文主要讲述主流的几种, 并对web server的基础架构做个简单的描述. 百度云实现方案: 百度移动云事业部的对云服务的Web Api借鉴了亚马逊的AWS实现方案. 具…