译文地址: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:用JSON构建API的标准指南中文版 本项目是网站的源码。 英文官方网址: : 。 资源 IRC频道:freenode.net上的#jsonapi 推特:@jsonapi 翻译 现状 本标准是当前正在开发中。如需贡献: 获取所有依赖: $ ...
-Redux JSON API 2的最低实现的快速入门指南 了解有关和核心原则的信息。 阅读有关JSON API的规范。 有助于 有任何意见或建议吗? 查看我们的。 贡献者 用 :purple_heart: 来自哥本哈根和。 最初由创业公司伪造。
在本指南中,您将学习如何为Pets构建JSON API ,以及如何使用模块将它们持久保存到关系数据库中。 是用于JavaSQL便捷库。 它尝试使用集合,Bean等在惯用Java中公开关系数据库访问,同时保持与JDBC相同的详细程度。 ...
将修改后的模板写入json文件到自定义(构建)目录中 使用项目package.json文件作为模板 内容 用法(请参阅此页的下一页) 开发者 软件包grunt-jsonfile的API 变更日志 入门 本指南假定您熟悉npm和grunt的使用。 ...
builder:节点模块使用data文件生成 jenkins 网站在web使用的 md 文件以及api用于静态 API 的 YAML 和 JSON 文件 数据:包含 API 样本数据的 YAML 文件 脚本:用于构建和部署 API 样书网站和 API 的脚本 web:...
通过在其上构建在线工具,我希望帮助越南标准数据覆盖更多应用程序开发人员,尤其是 Web 前端应用程序,其中包含大 JSON 文件不是一个优化选项。 最终,它可以帮助企业更好地协作(通过使用相同的标准数据)并使...
是一个用于 Web 开发的微框架,该模板为使用 JSON API 构建应用程序提供了一个起点。 示例应用程序使用作为主数据库,文档将指导您如何使用Ox助手以非常简单的方式与您的应用程序交互,用于开发和测试。 入门 确保...
actionScript 3.0开发人员指南中文版,总共67章,955页。学习actionScript不错的书籍。 目录: 目录 第章:使用日期和时间 管理日历日期和时间 控制时间间隔 日期和时间示例:简单模拟时钟 第章:使用字符串 字符串...
您将学习如何使用构建简单的JSON API 。 该服务将在以下位置提供: http://localhost:8080/greeting 并使用JSON响应进行响应: { " id " : 1 , " name " : " Hello World! " } 提供了两种编程模型: 脚本,...
定义用于构建API的约定的地方 在可用的情况下提供完整的资源 提供标准时间戳 使用 ISO8601 格式的 UTC 时间 嵌套外键关系 生成结构化错误 显示速率限制状态 在所有响应中保持 JSON 缩小 基本工具 在 Hyper 中使用...
总览这是一个样板应用程序,用于使用ES6,Express PostgreSQL和Sequelize ORM以及代码覆盖率和JWT身份验证在Node.js中构建REST API。 遵循最佳做法可帮助您保持生产力。 遵循。 深受和。产品特点特征概要ES6通过...
该项目是通过引导的。... 使用AJAX请求获取数据与API后端集成节点Ruby on Rails 在开发中代理API请求配置代理后出现“无效的主机头”错误手动配置代理配置WebSocket代理在开发中使用HTTPS 在服务器上生成动态<met
使用称为 OpenAPI 的东西写下你的 API 做了什么 制作一个 JSON 清单文件(它就像您的插件的一张小身份证) 听起来很酷,对吧?如果其中一些术语听起来有点棘手,请不要担心 - 我们将逐步分解所有内容,以便您轻松...
钛-docs ... :check_mark_button: 为了方便起见,存储库当前包含一个预先生成的api.json因此,如果您只想使用新文档,可以跳过此过程。 以下步骤假定您已经签出了平行于Titanium(包括Windows运行
这个项目是用React构建的。 数据通过API和JSON消耗,因此不需要后端。 安装 克隆此仓库 运行npm install 运行gulp将自动在浏览器中打开localhost端口并启用实时重新加载 API和资源 此应用程序使用[Nutritionix API...
Dropwizard/Jetty)构建服务器。 请参阅 或查看我们的指南以定义您的第一个 Conjure API。 特征 使团队能够跨多种语言一起工作 消除了一整类序列化错误 抽象出人体工程学界面背后的低级细节 用于建模域的表达性语言...
不幸的是,它仅是供人类在浏览器中查看的,并且如果人们要构建脚本来解析信息,则使用cURL访问和解析所需的信息是相当棘手的,因为该网站使用了大量JavaScript和AJAX在后台重新加载内容。 在我将尝试描述和收集有关...
哈皮Openapi 注意:此项目已从“ swaggerize-hapi”重命名为“ hapi...本指南将使您立即从api.json转到服务项目。 首先安装generator-swaggerize (如果尚未安装,请yo ): $ npm install -g yo $ npm install -g ge
本指南的目的是教授如何创建使用Rails :: API后端的Angular应用程序。 我们将使用Gulp构建客户端应用程序,并使用全部包含在同一存储库中的源代码将其部署到Heroku。 这是一个很好的堆栈,利用了Rails作为JSON API的...