JSON

[译] 用 JSON 构建 API 的标准指南

字号+ 作者:H5之家 来源:H5之家 2017-03-31 10:02 我要评论( )

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

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

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

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

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

顶级的 "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 阅读器在 这里 订阅本提要的变更。

     

    1.本站遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.本站的原创文章,请转载时务必注明文章作者和来源,不尊重原创的行为我们将追究责任;3.作者投稿可能会经我们编辑修改或补充。

    相关文章
    • 通过WordPress HTTP API 获取json内容并解析

      通过WordPress HTTP API 获取json内容并解析

      2017-04-01 10:17

    • 自己动手使用 Swift 打造全功能 JSON 解析、生成库

      自己动手使用 Swift 打造全功能 JSON 解析、生成库

      2017-03-29 16:01

    • PWA(Progressive Web App)入门系列:(一)PWA简介

      PWA(Progressive Web App)入门系列:(一)PWA简介

      2017-03-23 09:01

    • 如何让ASP.NET WEB API 默认回应JSON 格式

      如何让ASP.NET WEB API 默认回应JSON 格式

      2017-03-21 14:00

    网友点评