当前位置:首页 > 开发 > 编程语言 > Json > 正文

JSON API:用 JSON 构建 API 的标准指南中文版

发表于: 2014-10-14   作者:justjavac   来源:转载   浏览:
摘要: 译文地址:https://github.com/justjavac/json-api-zh_CN 如果你和你的团队曾经争论过使用什么方式构建合理 JSON 响应格式, 那么 JSON API 就是你的 anti-bikeshedding 武器。 通过遵循共同的约定,可以提高开发效率,利用更普遍的工具,可以是你更加专注于开发重点:你的程序。 基于 JSON API 的客户端还能够充分利用缓存,

译文地址:https://github.com/justjavac/json-api-zh_CN

如果你和你的团队曾经争论过使用什么方式构建合理 JSON 响应格式, 那么 JSON API 就是你的 anti-bikeshedding 武器。

通过遵循共同的约定,可以提高开发效率,利用更普遍的工具,可以是你更加专注于开发重点:你的程序。

基于 JSON API 的客户端还能够充分利用缓存,以提升性能,有时甚至可以完全不需要网络请求。

下面是一个使用 JSON API 发送响应(response)的示例:

{
  "links": {
    "posts.author": {
      "href": "http://example.com/people/{posts.author}",
      "type": "people"
    },
    "posts.comments": {
      "href": "http://example.com/comments/{posts.comments}",
      "type": "comments"
    }
  },
  "posts": [{
    "id": "1",
    "title": "Rails is Omakase",
    "links": {
      "author": "9",
      "comments": [ "5", "12", "17", "20" ]
    }
  }]
}
 

顶级的 "links" 部分是可选的。 除去 "links" 部分,此响应看起来非常接近使用已经存在的 API 构建的响应。

JSON API 不仅可以用来构建响应,还包括创建和更新资源。

现状

本文档是一个正在进展的工作,在具体实现过程中将会有所改变。详细信息请查看现状页面。

MIME 类型

JSON API 已经在 IANA 机构完成注册。 它的 MIME 类型是 application/vnd.api+json

格式

在开始使用 JSON API 前,先查看一下JSON API 格式文档

更新历史

  • 2013-05-03:最初版本的草案。
  • 2013-07-22:媒体类型在 IANA 注册完成。

 

你可以使用 RSS 阅读器在这里订阅本提要的变更。

JSON API:用 JSON 构建 API 的标准指南中文版

  • 0

    开心

    开心

  • 0

    板砖

    板砖

  • 0

    感动

    感动

  • 0

    有用

    有用

  • 0

    疑问

    疑问

  • 0

    难过

    难过

  • 0

    无聊

    无聊

  • 0

    震惊

    震惊

编辑推荐
输出json var formatters = config.Formatters.Where(formatter => formatter.SupportedMediaTyp
查看jenkins的python api与json api,感觉两者相差不多,但还是有所区别,所以用BeyondCompare进行
最基本的两个要素:字符串(string),将做为name,值(value) 1.字符串 字符串(string)是由双引
Weather-China提供国内主要城市的天气预报服务,并同时提供JSON REST API调用,方便第三方网站集成
Weather-China提供国内主要城市的天气预报服务,并同时提供JSON REST API调用,方便第三方网站集成
Weather-China提供国内主要城市的天气预报服务,并同时提供JSON REST API调用,方便第三方网站集成
Insus.NET的系列Web Api学习文章,这篇算是计划中最后一篇了,删除JSON格式的文件记录。前一篇《Web
toJson()能把对象序列化为json 方法讲解 这个方法最多支持2个参数: angular.toJson(obj, pretty);
tastypie is a good thing. Haven't test it thoroughly. Gonna need some provement. Now I will i
toJson()能把对象序列化为json 方法讲解 这个方法最多支持2个参数: angular.toJson(obj, pretty);
版权所有 IT知识库 CopyRight © 2009-2015 IT知识库 IT610.com , All Rights Reserved. 京ICP备09083238号