diff --git a/README.html b/README.html deleted file mode 100644 index 6ba5bc1..0000000 --- a/README.html +++ /dev/null @@ -1,708 +0,0 @@ -<!DOCTYPE html><html> - -<head> -<meta charset="utf-8"> -<title>README</title> -<style type="text/css"> -body { - font-family: Helvetica, arial, sans-serif; - font-size: 14px; - line-height: 1.6; - padding-top: 10px; - padding-bottom: 10px; - background-color: white; - padding: 30px; } - -body > *:first-child { - margin-top: 0 !important; } -body > *:last-child { - margin-bottom: 0 !important; } - -a { - color: #4183C4; } -a.absent { - color: #cc0000; } -a.anchor { - display: block; - padding-left: 30px; - margin-left: -30px; - cursor: pointer; - position: absolute; - top: 0; - left: 0; - bottom: 0; } - -h1, h2, h3, h4, h5, h6 { - margin: 20px 0 10px; - padding: 0; - font-weight: bold; - -webkit-font-smoothing: antialiased; - cursor: text; - position: relative; } - -h1:hover a.anchor, h2:hover a.anchor, h3:hover a.anchor, h4:hover a.anchor, h5:hover a.anchor, h6:hover a.anchor { - background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA09pVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMy1jMDExIDY2LjE0NTY2MSwgMjAxMi8wMi8wNi0xNDo1NjoyNyAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNiAoMTMuMCAyMDEyMDMwNS5tLjQxNSAyMDEyLzAzLzA1OjIxOjAwOjAwKSAgKE1hY2ludG9zaCkiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6OUM2NjlDQjI4ODBGMTFFMTg1ODlEODNERDJBRjUwQTQiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6OUM2NjlDQjM4ODBGMTFFMTg1ODlEODNERDJBRjUwQTQiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo5QzY2OUNCMDg4MEYxMUUxODU4OUQ4M0REMkFGNTBBNCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo5QzY2OUNCMTg4MEYxMUUxODU4OUQ4M0REMkFGNTBBNCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PsQhXeAAAABfSURBVHjaYvz//z8DJYCRUgMYQAbAMBQIAvEqkBQWXI6sHqwHiwG70TTBxGaiWwjCTGgOUgJiF1J8wMRAIUA34B4Q76HUBelAfJYSA0CuMIEaRP8wGIkGMA54bgQIMACAmkXJi0hKJQAAAABJRU5ErkJggg==) no-repeat 10px center; - text-decoration: none; } - -h1 tt, h1 code { - font-size: inherit; } - -h2 tt, h2 code { - font-size: inherit; } - -h3 tt, h3 code { - font-size: inherit; } - -h4 tt, h4 code { - font-size: inherit; } - -h5 tt, h5 code { - font-size: inherit; } - -h6 tt, h6 code { - font-size: inherit; } - -h1 { - font-size: 28px; - color: black; } - -h2 { - font-size: 24px; - border-bottom: 1px solid #cccccc; - color: black; } - -h3 { - font-size: 18px; } - -h4 { - font-size: 16px; } - -h5 { - font-size: 14px; } - -h6 { - color: #777777; - font-size: 14px; } - -p, blockquote, ul, ol, dl, li, table, pre { - margin: 15px 0; } - -hr { - background: transparent url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAYAAAAECAYAAACtBE5DAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyJpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuMC1jMDYwIDYxLjEzNDc3NywgMjAxMC8wMi8xMi0xNzozMjowMCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENTNSBNYWNpbnRvc2giIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6OENDRjNBN0E2NTZBMTFFMEI3QjRBODM4NzJDMjlGNDgiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6OENDRjNBN0I2NTZBMTFFMEI3QjRBODM4NzJDMjlGNDgiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo4Q0NGM0E3ODY1NkExMUUwQjdCNEE4Mzg3MkMyOUY0OCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo4Q0NGM0E3OTY1NkExMUUwQjdCNEE4Mzg3MkMyOUY0OCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PqqezsUAAAAfSURBVHjaYmRABcYwBiM2QSA4y4hNEKYDQxAEAAIMAHNGAzhkPOlYAAAAAElFTkSuQmCC) repeat-x 0 0; - border: 0 none; - color: #cccccc; - height: 4px; - padding: 0; -} - -body > h2:first-child { - margin-top: 0; - padding-top: 0; } -body > h1:first-child { - margin-top: 0; - padding-top: 0; } - body > h1:first-child + h2 { - margin-top: 0; - padding-top: 0; } -body > h3:first-child, body > h4:first-child, body > h5:first-child, body > h6:first-child { - margin-top: 0; - padding-top: 0; } - -a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 { - margin-top: 0; - padding-top: 0; } - -h1 p, h2 p, h3 p, h4 p, h5 p, h6 p { - margin-top: 0; } - -li p.first { - display: inline-block; } -li { - margin: 0; } -ul, ol { - padding-left: 30px; } - -ul :first-child, ol :first-child { - margin-top: 0; } - -dl { - padding: 0; } - dl dt { - font-size: 14px; - font-weight: bold; - font-style: italic; - padding: 0; - margin: 15px 0 5px; } - dl dt:first-child { - padding: 0; } - dl dt > :first-child { - margin-top: 0; } - dl dt > :last-child { - margin-bottom: 0; } - dl dd { - margin: 0 0 15px; - padding: 0 15px; } - dl dd > :first-child { - margin-top: 0; } - dl dd > :last-child { - margin-bottom: 0; } - -blockquote { - border-left: 4px solid #dddddd; - padding: 0 15px; - color: #777777; } - blockquote > :first-child { - margin-top: 0; } - blockquote > :last-child { - margin-bottom: 0; } - -table { - padding: 0;border-collapse: collapse; } - table tr { - border-top: 1px solid #cccccc; - background-color: white; - margin: 0; - padding: 0; } - table tr:nth-child(2n) { - background-color: #f8f8f8; } - table tr th { - font-weight: bold; - border: 1px solid #cccccc; - margin: 0; - padding: 6px 13px; } - table tr td { - border: 1px solid #cccccc; - margin: 0; - padding: 6px 13px; } - table tr th :first-child, table tr td :first-child { - margin-top: 0; } - table tr th :last-child, table tr td :last-child { - margin-bottom: 0; } - -img { - max-width: 100%; } - -span.frame { - display: block; - overflow: hidden; } - span.frame > span { - border: 1px solid #dddddd; - display: block; - float: left; - overflow: hidden; - margin: 13px 0 0; - padding: 7px; - width: auto; } - span.frame span img { - display: block; - float: left; } - span.frame span span { - clear: both; - color: #333333; - display: block; - padding: 5px 0 0; } -span.align-center { - display: block; - overflow: hidden; - clear: both; } - span.align-center > span { - display: block; - overflow: hidden; - margin: 13px auto 0; - text-align: center; } - span.align-center span img { - margin: 0 auto; - text-align: center; } -span.align-right { - display: block; - overflow: hidden; - clear: both; } - span.align-right > span { - display: block; - overflow: hidden; - margin: 13px 0 0; - text-align: right; } - span.align-right span img { - margin: 0; - text-align: right; } -span.float-left { - display: block; - margin-right: 13px; - overflow: hidden; - float: left; } - span.float-left span { - margin: 13px 0 0; } -span.float-right { - display: block; - margin-left: 13px; - overflow: hidden; - float: right; } - span.float-right > span { - display: block; - overflow: hidden; - margin: 13px auto 0; - text-align: right; } - -code, tt { - margin: 0 2px; - padding: 0 5px; - white-space: nowrap; - border: 1px solid #eaeaea; - background-color: #f8f8f8; - border-radius: 3px; } - -pre code { - margin: 0; - padding: 0; - white-space: pre; - border: none; - background: transparent; } - -.highlight pre { - background-color: #f8f8f8; - border: 1px solid #cccccc; - font-size: 13px; - line-height: 19px; - overflow: auto; - padding: 6px 10px; - border-radius: 3px; } - -pre { - background-color: #f8f8f8; - border: 1px solid #cccccc; - font-size: 13px; - line-height: 19px; - overflow: auto; - padding: 6px 10px; - border-radius: 3px; } - pre code, pre tt { - background-color: transparent; - border: none; } - -sup { - font-size: 0.83em; - vertical-align: super; - line-height: 0; -} -* { - -webkit-print-color-adjust: exact; -} -@media screen and (min-width: 914px) { - body { - width: 854px; - margin:0 auto; - } -} -@media print { - table, pre { - page-break-inside: avoid; - } - pre { - word-wrap: break-word; - } -} -</style> - -</head><body> -<h1>HTTP API 设计指南</h1> - -<blockquote> -<p>翻译自 <code>HTTP API Design Guide</code> <a href="https://github.com/interagent/http-api-design">https://github.com/interagent/http-api-design</a></p> -</blockquote> - -<ul> -<li>更新时间:<code>2015-02-04</code></li> -<li>欢迎大家问题和共同维护这个文档</li> -<li>HTML和PDF通过<code>Mou</code>生成</li> -<li>翻译人员见<code>CONTRIBUTORS.md</code></li> -</ul> - -<h2>前言</h2> - -<p>这篇指南介绍了大量的 HTTP+JSON 的api设计风格,最初摘录自heroku平台的api设计指引 <a href="https://devcenter.heroku.com/articles/platform-api-reference">Heroku 平台 API 指引</a>。</p> - -<p>这篇指南除了介绍那些API,同时也适用于heroku平台新集成的API,我们希望那些在Heroku之外的API设计者也感兴趣。</p> - -<p>我们的目标是一致性,专注业务逻辑同时避免设计上的空想。我们一直在寻找一种良好的、统一的、显而易见的API设计方式,未必只有一种方式。</p> - -<p>我们假设你熟悉基本的 HTTP+JSON API 设计方式,但是,不一定包含在此篇指南里面的所有内容。</p> - -<p>我们欢迎你为这篇指南做<a href="https://github.com/interagent/http-api-design/blob/master/CONTRIBUTING.md">贡献</a>。</p> - -<h2>目录</h2> - -<ul> -<li>基础 - -<ul> -<li>强制使用安全连接(Secure Connections)</li> -<li>强制头信息 Accept 中提供版本号</li> -<li>支持Etag缓存</li> -<li>为内省而提供 Request-Id</li> -<li>通过请求中的范围(Range)拆分大的响应</li> -</ul></li> -<li>请求(Requests) - -<ul> -<li>返回合适的状态码</li> -<li>提供全部可用的资源</li> -<li>在请求的body体使用JSON格式数据</li> -<li>使用统一的资源路径格式</li> -<li>路径和属性要小写</li> -<li>支持方便的无id间接引用</li> -<li>最小化路径嵌套</li> -</ul></li> -<li>响应(Responses) - -<ul> -<li>提供资源的(UU)ID</li> -<li>提供标准的时间戳</li> -<li>使用UTC(世界标准时间)时间,用ISO8601进行格式化</li> -<li>嵌套外键关系</li> -<li>生成结构化的错误</li> -<li>显示频率限制状态</li> -<li>保证响应JSON最小化</li> -</ul></li> -<li>工件(Artifacts) - -<ul> -<li>提供机器可读的JSON模式</li> -<li>提供人类可读的文档</li> -<li>提供可执行的例子</li> -<li>描述稳定性</li> -</ul></li> -<li>译者注</li> -</ul> - -<h3>基础</h3> - -<h4>隔离关注点</h4> - -<p>设计时通过将请求和响应之间的不同部分隔离来让事情变得简单。保持简单的规则让我们能更关注在一些更大的更困难的问题上。</p> - -<p>请求和响应将解决一个特定的资源或集合。使用路径(path)来表明身份,body来传输内容(content)还有头信息(header)来传递元数据(metadata)。查询参数同样可以用来传递头信息的内容,但头信息是首选,因为他们更灵活、更能传达不同的信息。</p> - -<h4>强制使用安全连接(Secure Connections)</h4> - -<p>所有的访问API行为,都需要用 TLS 通过安全连接来访问。没有必要搞清或解释什么情况需要 TLS 什么情况不需要 TLS,直接强制任何访问都要通过 TLS。</p> - -<p>理想状态下,通过拒绝所有非 TLS 请求,不响应 http 或80端口的请求以避免任何不安全的数据交换。如果现实情况中无法这样做,可以返回<code>403 Forbidden</code>响应。</p> - -<p>重定向是不推荐的,因为他们允许不好的客户端的行为,不提供任何明确的目标。客户依赖重定会加倍服务器流量和渲染 TLS 也没有作用,因为敏感数据已经无用在第一次调用已经暴露。</p> - -<h4>强制头信息 Accept 中提供版本号</h4> - -<p>版本和版本之间的过渡对于设计和操作API是一个非常大的挑战。这样,最好是开始时就有一些机制来缓和这个过渡。</p> - -<p>为了防止意外,打破更改用户,最好是与所有请求都需要指定一个版本。为了将来的修改,最好不要提供默认的版本。</p> - -<p>最好是在头信息中指定版本号,和其它数据一起,通过<code>Accepts</code>自定义内容类型(content type)同时传递,例如:</p> - -<pre><code>Accept: application/vnd.heroku+json; version=3 -</code></pre> - -<h4>支持Etag缓存</h4> - -<p>在所有请求响应中包含一个<code>ETag</code>头,标识出返回资源的版本。这样就允许用户去缓存这些资源,请求时将<code>ETag</code>的值设置到<code>If-None-Match</code>头信息中就可以知道是否需要更新缓存了。</p> - -<h4>为内省而提供 Request-Id</h4> - -<p>为每一个请求响应包含一个<code>Request-Id</code>字段,使用UUID作为该值。如果服务器和客户端同时记录下这些内容,这样对于跟踪和调试请求非常有帮助。</p> - -<p>为每一个请求响应包含一个<code>Request-Id</code>字段,并使用UUID作为该值。通过在客户端、服务器或任何支持服务上记录该值,它能主我们提供一种机制来跟踪、诊断和调试请求。</p> - -<h4>通过请求中的范围(Range)拆分大的响应</h4> - -<p>一个大的响应应该通过多个请求使用<code>Range</code>头信息来拆分,并指定如何取得。详细的请求和响应的头信息(header),状态码(status code),范围(limit),排序(ordering)和迭代(iteration)等,参考<a href="https://devcenter.heroku.com/articles/platform-api-reference#ranges">Heroku Platform API discussion of Ranges</a>.</p> - -<h3>请求(Requests)</h3> - -<h4>返回合适的状态码</h4> - -<p>为每一次的响应返回合适的HTTP状态码。 好的响应应该使用如下的状态码:</p> - -<ul> -<li><code>200</code>: <code>GET</code>请求成功,及<code>DELETE</code>或<code>PATCH</code>同步请求完成,或者<code>PUT</code>同步更新一个已存在的资源</li> -<li><code>201</code>: <code>POST</code> 同步请求完成,或者<code>PUT</code>同步创建一个新的资源</li> -<li><code>202</code>: <code>POST</code>,<code>PUT</code>,<code>DELETE</code>,或<code>PATCH</code>请求接收,将被异步处理</li> -<li><code>206</code>: <code>GET</code> 请求成功,但是只返回一部分,参考:<a href="#%E6%8C%89%E8%8C%83%E5%9B%B4%E5%88%86%E9%A1%B5">上文中范围分页</a></li> -</ul> - -<p>使用身份认证(authentication)和授权(authorization)错误码时需要注意:</p> - -<ul> -<li><code>401 Unauthorized</code>: 用户未认证,请求失败</li> -<li><code>403 Forbidden</code>: 用户无权限访问该资源,请求失败</li> -</ul> - -<p>当用户请求错误时,提供合适的状态码可以提供额外的信息:</p> - -<ul> -<li><code>422 Unprocessable Entity</code>: 请求被服务器正确解析,但是包含无效字段</li> -<li><code>429 Too Many Requests</code>: 因为访问频繁,你已经被限制访问,稍后重试</li> -<li><code>500 Internal Server Error</code>: 服务器错误,确认状态并报告问题</li> -</ul> - -<p>对于用户错误和服务器错误情况状态码,参考: <a href="https://tools.ietf.org/html/rfc7231#section-6">HTTP response code spec</a></p> - -<h4>提供全部可用的资源</h4> - -<p>提供全部可显现的资源 (例如: 这个对象的所有属性) ,当响应码为200或是201时返回所有可用资源,包含 <code>PUT</code>/<code>PATCH</code> 和 <code>DELETE</code><br> -请求,例如:</p> - -<pre><code class="json">$ curl -X DELETE \ - https://service.com/apps/1f9b/domains/0fd4 - -HTTP/1.1 200 OK -Content-Type: application/json;charset=utf-8 -... -{ - "created_at": "2012-01-01T12:00:00Z", - "hostname": "subdomain.example.com", - "id": "01234567-89ab-cdef-0123-456789abcdef", - "updated_at": "2012-01-01T12:00:00Z" -} -</code></pre> - -<p>当请求状态码为202时,不返回所有可用资源,例如:</p> - -<pre><code>$ curl -X DELETE \ - https://service.com/apps/1f9b/dynos/05bd - -HTTP/1.1 202 Accepted -Content-Type: application/json;charset=utf-8 -... -{} -</code></pre> - -<h4>在请求的body体使用JSON格式数据</h4> - -<p>在 <code>PUT</code>/<code>PATCH</code>/<code>POST</code> 请求的正文(request bodies)中使用JSON格式数据,而不是使用 form 表单形式的数据。这与我们使用JSON格式返回请求相对应,例如:</p> - -<pre><code>$ curl -X POST https://service.com/apps \ - -H "Content-Type: application/json" \ - -d '{"name": "demoapp"}' - -{ - "id": "01234567-89ab-cdef-0123-456789abcdef", - "name": "demoapp", - "owner": { - "email": "username@example.com", - "id": "01234567-89ab-cdef-0123-456789abcdef" - }, - ... -} -</code></pre> - -<h4>使用统一的资源路径格式</h4> - -<h5>资源名(Resource names)</h5> - -<p>使用复数形式为资源命名,除非这个资源在系统中是单例的 (例如,在大多数系统中,给定的用户帐户只有一个)。 这种方式保持了特定资源的统一性。</p> - -<h5>形为(Actions)</h5> - -<p>好的末尾展现形式不许要为某个资源指定特殊的形为,在某些特殊情况下,指定特殊的资源的形为是必须的,为了清楚的描述,用一个标准的<code>actions</code>前缀去放置他们:</p> - -<pre><code>/resources/:resource/actions/:action -</code></pre> - -<p>例如:</p> - -<pre><code>/runs/{run_id}/actions/stop -</code></pre> - -<h4>路径和属性要小写</h4> - -<p>为了和域名命名规则保持一致,使用小写字母和<code>-</code>分割路径名字,例如:</p> - -<pre><code>service-api.com/users -service-api.com/app-setups -</code></pre> - -<p>属性同样也要用小写字母,但是属性名字要用下划线<code>_</code>分割,因为这样在JavaScript语言中不用输入引号。 例如:</p> - -<pre><code class="json">service_class: "first" -</code></pre> - -<h4>支持方便的无id间接引用</h4> - -<p>在某些情况下,让用户提供ID去定位资源是不方便的。例如,一个用户想取得他在Heroku平台app信息,但是这个app的唯一标识是UUID。这种情况下,你应该支持接口通过名字和ID都能访问,例如:</p> - -<pre><code>$ curl https://service.com/apps/{app_id_or_name} -$ curl https://service.com/apps/97addcf0-c182 -$ curl https://service.com/apps/www-prod -</code></pre> - -<p>不要只接受使用名字而放弃了使用id。</p> - -<h4>最小化路径嵌套</h4> - -<p>在一些有父路径/子路径嵌套关系的资源数据模块中,路径可能有非常深的嵌套关系,例如:</p> - -<pre><code>/orgs/{org_id}/apps/{app_id}/dynos/{dyno_id} -</code></pre> - -<p>推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。例如在上面的情况下,dyno属于app,app属于org可以表示为:</p> - -<pre><code>/orgs/{org_id} -/orgs/{org_id}/apps -/apps/{app_id} -/apps/{app_id}/dynos -/dynos/{dyno_id} -</code></pre> - -<h3>响应(Responses)</h3> - -<h4>提供资源的(UU)ID</h4> - -<p>在默认情况给每一个资源一个<code>id</code>属性。除非有更好的理由,否则请使用UUID。不要使用那种在服务器上或是资源中不是全局唯一的标识,尤其是自动增长的id。</p> - -<p>生成小写的UUID格式 <code>8-4-4-4-12</code>,例如:</p> - -<pre><code class="json">"id": "01234567-89ab-cdef-0123-456789abcdef" -</code></pre> - -<h4>提供标准的时间戳</h4> - -<p>为资源提供默认的创建时间 <code>created_at</code> 和更新时间 <code>updated_at</code>,例如:</p> - -<pre><code class="json">{ - ... - "created_at": "2012-01-01T12:00:00Z", - "updated_at": "2012-01-01T13:00:00Z", - ... -} -</code></pre> - -<p>有些资源不需要使用时间戳那么就忽略这两个字段。</p> - -<h4>使用UTC(世界标准时间)时间,用ISO8601进行格式化</h4> - -<p>在接收和返回时都只使用UTC格式。ISO8601格式的数据,例如:</p> - -<pre><code class="json">"finished_at": "2012-01-01T12:00:00Z" -</code></pre> - -<h4>嵌套外键关系</h4> - -<p>使用嵌套对象序列化外键关联,例如:</p> - -<pre><code class="json">{ - "name": "service-production", - "owner": { - "id": "5d8201b0..." - }, - // ... -} -</code></pre> - -<p>而不是像这样:</p> - -<pre><code class="json">{ - "name": "service-production", - "owner_id": "5d8201b0...", - ... -} -</code></pre> - -<p>这种方式尽可能的把相关联的资源信息内联在一起,而不用改变资源的结构,或者引入更多的字段 例如:</p> - -<pre><code class="json">{ - "name": "service-production", - "owner": { - "id": "5d8201b0...", - "name": "Alice", - "email": "alice@heroku.com" - }, - ... -} -</code></pre> - -<h4>生成结构化的错误</h4> - -<p>响应错误的时,生成统一的、结构化的错误信息。包含一个机器可读的错误 <code>id</code>,一个人类能识别的错误信息(<code>message</code>),根据情况可以添加一个<code>url</code>来告诉客户端关于这个错误的更多信息以及如何去解决它,例如:</p> - -<pre><code>HTTP/1.1 429 Too Many Requests -</code></pre> - -<pre><code class="json">{ - "id": "rate_limit", - "message": "Account reached its API rate limit.", - "url": "https://docs.service.com/rate-limits" -} -</code></pre> - -<p>文档化客户端可能遇到的错误信息格式,以及这些可能的错误信息<code>id</code>。</p> - -<h4>显示频率限制状态</h4> - -<p>客户端的访问速度限制可以维护服务器的良好状态,保证为其他客户端请求提供高性的服务。你可以使用<a href="http://en.wikipedia.org/wiki/Token_bucket">token bucket algorithm</a>技术量化请求限制。</p> - -<p>为每一个带有<code>RateLimit-Remaining</code>响应头的请求,返回预留的请求tokens。</p> - -<h4>保证响应JSON最小化</h4> - -<p>请求中多余的空格会增加响应大小,而且现在很多的HTTP客户端都会自己输出可读格式(<q>prettify</q>)的JSON。所以最好保证响应JSON最小化,例如:</p> - -<pre><code class="json">{"beta":false,"email":"alice@heroku.com","id":"01234567-89ab-cdef-0123-456789abcdef","last_login":"2012-01-01T12:00:00Z","created_at":"2012-01-01T12:00:00Z","updated_at":"2012-01-01T12:00:00Z"} -</code></pre> - -<p>而不是这样:</p> - -<pre><code class="json">{ - "beta": false, - "email": "alice@heroku.com", - "id": "01234567-89ab-cdef-0123-456789abcdef", - "last_login": "2012-01-01T12:00:00Z", - "created_at": "2012-01-01T12:00:00Z", - "updated_at": "2012-01-01T12:00:00Z" -} -</code></pre> - -<p>你可以提供可选的方式为客户端提供更详细可读的响应,使用查询参数(例如:<code>?pretty=true</code>)或者通过<code>Accept</code>头信息参数(例如:<code>Accept: application/vnd.heroku+json; version=3; indent=4;</code>)。</p> - -<h3>工件(Artifacts)</h3> - -<h4>提供机器可读的JSON模式</h4> - -<p>提供一个机器可读的模式来恰当的表现你的API。使用<br> -<a href="https://github.com/interagent/prmd">prmd</a>管理你的模式,并且确保用<code>prmd verify</code>验证是有效的。</p> - -<h4>提供人类可读的文档</h4> - -<p>提供人类可读的文档让客户端开发人员可以理解你的API。</p> - -<p>如果你用prmd创建了一个概要并且按上述要求描述,你可以为所有节点很容易的使用<code>prmd doc</code>生成Markdown文档。</p> - -<p>除了节点信息,提供一个API概述信息:</p> - -<ul> -<li>验证授权,包含如何取得和如何使用token。</li> -<li>API稳定及版本脂,包含如何选择所需要的版本。</li> -<li>一般情况下的请求和响应的头信息。</li> -<li>错误的序列化格式。</li> -<li>不同编程语言客户端使用API的例子。</li> -</ul> - -<h4>提供可执行的例子</h4> - -<p>提供可执行的示例让用户可以直接在终端里面看到API的调用情况,最大程度的让这些示例可以简单的使用,以减少用户尝试使用API的工作量。例如:</p> - -<pre><code>$ export TOKEN=... # acquire from dashboard -$ curl -is https://$TOKEN@service.com/users -</code></pre> - -<p>如果你使用<a href="https://github.com/interagent/prmd">prmd</a>生成Markdown文档,每个节点都会自动获取一些示例。</p> - -<h4>描述稳定性</h4> - -<p>描述您的API的稳定性或是它在各种各样节点环境中的完备性和稳定性,例如:加上 原型版(prototype)/开发版(development)/产品版(production)等标记。</p> - -<p>更多关于可能的稳定性和改变管理的方式,查看 <a href="https://devcenter.heroku.com/articles/api-compatibility-policy">Heroku API compatibility policy</a></p> - -<p>一旦你的API宣布产品正式版本及稳定版本时,不要在当前API版本中做一些不兼容的改变。如果你需要,请创建一个新的版本的API。</p> - -</body> - -</html> diff --git "a/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.html" "b/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.html" index 8029dc4..7ad2216 100644 --- "a/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.html" +++ "b/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.html" @@ -2,7 +2,7 @@ <head> <meta charset="utf-8"> -<title>http-api-设计指南</title> +<title>README</title> <style type="text/css"> body { font-family: Helvetica, arial, sans-serif; diff --git "a/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.md" "b/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.md" deleted file mode 100644 index d36e7cd..0000000 --- "a/http-api-\350\256\276\350\256\241\346\214\207\345\215\227.md" +++ /dev/null @@ -1,394 +0,0 @@ -# HTTP API 设计指南 -> 翻译自 `HTTP API Design Guide` [https://github.com/interagent/http-api-design](https://github.com/interagent/http-api-design) - -- 更新时间:`2015-02-04` -- 欢迎大家问题和共同维护这个文档 -- HTML和PDF通过`Mou`生成 -- 翻译人员见`CONTRIBUTORS.md` - -## 前言 - -这篇指南介绍了大量的 HTTP+JSON 的api设计风格,最初摘录自heroku平台的api设计指引 [Heroku 平台 API 指引](https://devcenter.heroku.com/articles/platform-api-reference)。 - -这篇指南除了介绍那些API,同时也适用于heroku平台新集成的API,我们希望那些在Heroku之外的API设计者也感兴趣。 - -我们的目标是一致性,专注业务逻辑同时避免设计上的空想。我们一直在寻找一种良好的、统一的、显而易见的API设计方式,未必只有一种方式。 - -我们假设你熟悉基本的 HTTP+JSON API 设计方式,但是,不一定包含在此篇指南里面的所有内容。 - -我们欢迎你为这篇指南做[贡献](https://github.com/interagent/http-api-design/blob/master/CONTRIBUTING.md)。 - -## 目录 - -* 基础 - * 强制使用安全连接(Secure Connections) - * 强制头信息 Accept 中提供版本号 - * 支持Etag缓存 - * 为内省而提供 Request-Id - * 通过请求中的范围(Range)拆分大的响应 -* 请求(Requests) - * 返回合适的状态码 - * 提供全部可用的资源 - * 在请求的body体使用JSON格式数据 - * 使用统一的资源路径格式 - * 路径和属性要小写 - * 支持方便的无id间接引用 - * 最小化路径嵌套 -* 响应(Responses) - * 提供资源的(UU)ID - * 提供标准的时间戳 - * 使用UTC(世界标准时间)时间,用ISO8601进行格式化 - * 嵌套外键关系 - * 生成结构化的错误 - * 显示频率限制状态 - * 保证响应JSON最小化 -* 工件(Artifacts) - * 提供机器可读的JSON模式 - * 提供人类可读的文档 - * 提供可执行的例子 - * 描述稳定性 -* 译者注 - - -### 基础 - -#### 隔离关注点 -设计时通过将请求和响应之间的不同部分隔离来让事情变得简单。保持简单的规则让我们能更关注在一些更大的更困难的问题上。 - -请求和响应将解决一个特定的资源或集合。使用路径(path)来表明身份,body来传输内容(content)还有头信息(header)来传递元数据(metadata)。查询参数同样可以用来传递头信息的内容,但头信息是首选,因为他们更灵活、更能传达不同的信息。 - -#### 强制使用安全连接(Secure Connections) - -所有的访问API行为,都需要用 TLS 通过安全连接来访问。没有必要搞清或解释什么情况需要 TLS 什么情况不需要 TLS,直接强制任何访问都要通过 TLS。 - -理想状态下,通过拒绝所有非 TLS 请求,不响应 http 或80端口的请求以避免任何不安全的数据交换。如果现实情况中无法这样做,可以返回`403 Forbidden`响应。 - -把非 TLS 的请求重定向(Redirect)至 TLS 连接是不明智的,这种含混/不好的客户端行为不会带来明显好处。依赖于重定向的客户端访问不仅会导致双倍的服务器负载,还会使 TLS 加密失去意义,因为在首次非 TLS 调用时,敏感信息就已经暴露出去了。 - -#### 强制头信息 Accept 中提供版本号 - -制定版本并在版本之间平缓过渡对于设计和维护一套API是个巨大的挑战。所以,最好在设计之初就使用一些方法来预防可能会遇到的问题。 - -为了避免API的变动导致用户使用中产生意外结果或调用失败,最好强制要求所有访问都需要指定版本号。请避免提供默认版本号,一旦提供,日后想要修改它会相当困难。 - -最适合放置版本号的位置是头信息(HTTP Headers),在`Accepts`段中使用自定义类型(content type)与其他元数据(metadata)一起提交。例如: - -``` -Accept: application/vnd.heroku+json; version=3 -``` - -#### 支持Etag缓存 - -在所有请求响应中包含一个`ETag`头,标识出返回资源的版本。这样就允许用户去缓存这些资源,请求时将`ETag`的值设置到`If-None-Match`头信息中就可以知道是否需要更新缓存了。 - -#### 为内省而提供 Request-Id - -为每一个请求响应包含一个`Request-Id`字段,使用UUID作为该值。如果服务器和客户端同时记录下这些内容,这样对于跟踪和调试请求非常有帮助。 - -为每一个请求响应包含一个`Request-Id`字段,并使用UUID作为该值。通过在客户端、服务器或任何支持服务上记录该值,它能主我们提供一种机制来跟踪、诊断和调试请求。 - -#### 通过请求中的范围(Range)拆分大的响应 - -一个大的响应应该通过多个请求使用`Range`头信息来拆分,并指定如何取得。详细的请求和响应的头信息(header),状态码(status code),范围(limit),排序(ordering)和迭代(iteration)等,参考[Heroku Platform API discussion of Ranges](https://devcenter.heroku.com/articles/platform-api-reference#ranges). - -###请求(Requests) - -#### 返回合适的状态码 - -为每一次的响应返回合适的HTTP状态码。 好的响应应该使用如下的状态码: - -* `200`: `GET`请求成功,及`DELETE`或`PATCH`同步请求完成,或者`PUT`同步更新一个已存在的资源 -* `201`: `POST` 同步请求完成,或者`PUT`同步创建一个新的资源 -* `202`: `POST`,`PUT`,`DELETE`,或`PATCH`请求接收,将被异步处理 -* `206`: `GET` 请求成功,但是只返回一部分,参考:[上文中范围分页](#按范围分页) - -使用身份认证(authentication)和授权(authorization)错误码时需要注意: - -* `401 Unauthorized`: 用户未认证,请求失败 -* `403 Forbidden`: 用户无权限访问该资源,请求失败 - -当用户请求错误时,提供合适的状态码可以提供额外的信息: - -* `422 Unprocessable Entity`: 请求被服务器正确解析,但是包含无效字段 -* `429 Too Many Requests`: 因为访问频繁,你已经被限制访问,稍后重试 -* `500 Internal Server Error`: 服务器错误,确认状态并报告问题 - -对于用户错误和服务器错误情况状态码,参考: [HTTP response code spec](https://tools.ietf.org/html/rfc7231#section-6) - -#### 提供全部可用的资源 - -提供全部可显现的资源 (例如: 这个对象的所有属性) ,当响应码为200或是201时返回所有可用资源,包含 `PUT`/`PATCH` 和 `DELETE` -请求,例如: - - -```json -$ curl -X DELETE \ - https://service.com/apps/1f9b/domains/0fd4 - -HTTP/1.1 200 OK -Content-Type: application/json;charset=utf-8 -... -{ - "created_at": "2012-01-01T12:00:00Z", - "hostname": "subdomain.example.com", - "id": "01234567-89ab-cdef-0123-456789abcdef", - "updated_at": "2012-01-01T12:00:00Z" -} -``` - -当请求状态码为202时,不返回所有可用资源,例如: - -``` -$ curl -X DELETE \ - https://service.com/apps/1f9b/dynos/05bd - -HTTP/1.1 202 Accepted -Content-Type: application/json;charset=utf-8 -... -{} -``` - -#### 在请求的body体使用JSON格式数据 - -在 `PUT`/`PATCH`/`POST` 请求的正文(request bodies)中使用JSON格式数据,而不是使用 form 表单形式的数据。这与我们使用JSON格式返回请求相对应,例如: - -``` -$ curl -X POST https://service.com/apps \ - -H "Content-Type: application/json" \ - -d '{"name": "demoapp"}' - -{ - "id": "01234567-89ab-cdef-0123-456789abcdef", - "name": "demoapp", - "owner": { - "email": "username@example.com", - "id": "01234567-89ab-cdef-0123-456789abcdef" - }, - ... -} -``` - -#### 使用统一的资源路径格式 - -##### 资源名(Resource names) - -使用复数形式为资源命名,除非这个资源在系统中是单例的 (例如,在大多数系统中,给定的用户帐户只有一个)。 这种方式保持了特定资源的统一性。 - -##### 形为(Actions) - -好的末尾展现形式不许要为某个资源指定特殊的形为,在某些特殊情况下,指定特殊的资源的形为是必须的,为了清楚的描述,用一个标准的`actions`前缀去放置他们: - -``` -/resources/:resource/actions/:action -``` - -例如: - -``` -/runs/{run_id}/actions/stop -``` - -#### 路径和属性要小写 - -为了和域名命名规则保持一致,使用小写字母和`-`分割路径名字,例如: - -``` -service-api.com/users -service-api.com/app-setups -``` - -属性同样也要用小写字母,但是属性名字要用下划线`_`分割,因为这样在JavaScript语言中不用输入引号。 例如: - -```json -service_class: "first" -``` - -#### 支持方便的无id间接引用 - -在某些情况下,让用户提供ID去定位资源是不方便的。例如,一个用户想取得他在Heroku平台app信息,但是这个app的唯一标识是UUID。这种情况下,你应该支持接口通过名字和ID都能访问,例如: - -``` -$ curl https://service.com/apps/{app_id_or_name} -$ curl https://service.com/apps/97addcf0-c182 -$ curl https://service.com/apps/www-prod -``` -不要只接受使用名字而放弃了使用id。 - -#### 最小化路径嵌套 - -在一些有父路径/子路径嵌套关系的资源数据模块中,路径可能有非常深的嵌套关系,例如: - -``` -/orgs/{org_id}/apps/{app_id}/dynos/{dyno_id} -``` - -推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。例如在上面的情况下,dyno属于app,app属于org可以表示为: - -``` -/orgs/{org_id} -/orgs/{org_id}/apps -/apps/{app_id} -/apps/{app_id}/dynos -/dynos/{dyno_id} -``` - -### 响应(Responses) - -#### 提供资源的(UU)ID - -在默认情况给每一个资源一个`id`属性。除非有更好的理由,否则请使用UUID。不要使用那种在服务器上或是资源中不是全局唯一的标识,尤其是自动增长的id。 - -生成小写的UUID格式 `8-4-4-4-12`,例如: - -```json -"id": "01234567-89ab-cdef-0123-456789abcdef" -``` - -#### 提供标准的时间戳 - -为资源提供默认的创建时间 `created_at` 和更新时间 `updated_at`,例如: - -```json -{ - ... - "created_at": "2012-01-01T12:00:00Z", - "updated_at": "2012-01-01T13:00:00Z", - ... -} -``` - -有些资源不需要使用时间戳那么就忽略这两个字段。 - -#### 使用UTC(世界标准时间)时间,用ISO8601进行格式化 - -在接收和返回时都只使用UTC格式。ISO8601格式的数据,例如: - -```json -"finished_at": "2012-01-01T12:00:00Z" -``` - -#### 嵌套外键关系 - -使用嵌套对象序列化外键关联,例如: - -```json -{ - "name": "service-production", - "owner": { - "id": "5d8201b0..." - }, - // ... -} -``` - -而不是像这样: - -```json -{ - "name": "service-production", - "owner_id": "5d8201b0...", - ... -} -``` - -这种方式尽可能的把相关联的资源信息内联在一起,而不用改变资源的结构,或者引入更多的字段 例如: - -```json -{ - "name": "service-production", - "owner": { - "id": "5d8201b0...", - "name": "Alice", - "email": "alice@heroku.com" - }, - ... -} -``` - -#### 生成结构化的错误 - -响应错误的时,生成统一的、结构化的错误信息。包含一个机器可读的错误 `id`,一个人类能识别的错误信息(`message`),根据情况可以添加一个`url`来告诉客户端关于这个错误的更多信息以及如何去解决它,例如: - -``` -HTTP/1.1 429 Too Many Requests -``` - -```json -{ - "id": "rate_limit", - "message": "Account reached its API rate limit.", - "url": "https://docs.service.com/rate-limits" -} -``` - -文档化客户端可能遇到的错误信息格式,以及这些可能的错误信息`id`。 - -#### 显示频率限制状态 - -客户端的访问速度限制可以维护服务器的良好状态,保证为其他客户端请求提供高性的服务。你可以使用[token bucket algorithm](http://en.wikipedia.org/wiki/Token_bucket)技术量化请求限制。 - -为每一个带有`RateLimit-Remaining`响应头的请求,返回预留的请求tokens。 - -#### 保证响应JSON最小化 - -请求中多余的空格会增加响应大小,而且现在很多的HTTP客户端都会自己输出可读格式("prettify")的JSON。所以最好保证响应JSON最小化,例如: - -```json -{"beta":false,"email":"alice@heroku.com","id":"01234567-89ab-cdef-0123-456789abcdef","last_login":"2012-01-01T12:00:00Z","created_at":"2012-01-01T12:00:00Z","updated_at":"2012-01-01T12:00:00Z"} -``` - -而不是这样: - -```json -{ - "beta": false, - "email": "alice@heroku.com", - "id": "01234567-89ab-cdef-0123-456789abcdef", - "last_login": "2012-01-01T12:00:00Z", - "created_at": "2012-01-01T12:00:00Z", - "updated_at": "2012-01-01T12:00:00Z" -} -``` - -你可以提供可选的方式为客户端提供更详细可读的响应,使用查询参数(例如:`?pretty=true`)或者通过`Accept`头信息参数(例如:`Accept: application/vnd.heroku+json; version=3; indent=4;`)。 - -###工件(Artifacts) - - -#### 提供机器可读的JSON模式 - -提供一个机器可读的模式来恰当的表现你的API。使用 -[prmd](https://github.com/interagent/prmd)管理你的模式,并且确保用`prmd verify`验证是有效的。 - -#### 提供人类可读的文档 - -提供人类可读的文档让客户端开发人员可以理解你的API。 - -如果你用prmd创建了一个概要并且按上述要求描述,你可以为所有节点很容易的使用`prmd doc`生成Markdown文档。 - -除了节点信息,提供一个API概述信息: - -* 验证授权,包含如何取得和如何使用token。 -* API稳定及版本管理,包含如何选择所需要的版本。 -* 一般情况下的请求和响应的头信息。 -* 错误的序列化格式。 -* 不同编程语言客户端使用API的例子。 - -#### 提供可执行的例子 - -提供可执行的示例让用户可以直接在终端里面看到API的调用情况,最大程度的让这些示例可以简单的使用,以减少用户尝试使用API的工作量。例如: - -``` -$ export TOKEN=... # acquire from dashboard -$ curl -is https://$TOKEN@service.com/users -``` - -如果你使用[prmd](https://github.com/interagent/prmd)生成Markdown文档,每个节点都会自动获取一些示例。 - -#### 描述稳定性 - -描述您的API的稳定性或是它在各种各样节点环境中的完备性和稳定性,例如:加上 原型版(prototype)/开发版(development)/产品版(production)等标记。 - -更多关于可能的稳定性和改变管理的方式,查看 [Heroku API compatibility policy](https://devcenter.heroku.com/articles/api-compatibility-policy) - -一旦你的API宣布产品正式版本及稳定版本时,不要在当前API版本中做一些不兼容的改变。如果你需要,请创建一个新的版本的API。