8000 Merge pull request #10 from stranbird/master · samuelcs/http-api-design-ZH_CN@7ae957f · GitHub
[go: up one dir, main page]

Skip to content

Commit 7ae957f

Browse files
committed
Merge pull request ZhangBohan#10 from stranbird/master
fix typo and rephrase some sentences
2 parents c52b9cc + 8db63db commit 7ae957f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
< 8000 div data-testid="addition diffstat" class="DiffSquares-module__diffSquare--h5kjy DiffSquares-module__addition--jeNtt">
Original file line numberDiff line numberDiff line change
@@ -174,9 +174,9 @@ $ curl -X POST https://service.com/apps \
174174

175175
使用复数形式为资源命名,除非这个资源在系统中是单例的 (例如,在大多数系统中,给定的用户帐户只有一个)。 这种方式保持了特定资源的统一性。
176176

177-
##### 形为(Actions)
177+
##### 行为(Actions)
178178

179-
好的末尾展现形式不许要为某个资源指定特殊的形为,在某些特殊情况下,指定特殊的资源的形为是必须的,为了清楚的描述,用一个标准的`actions`前缀去放置他们:
179+
好的末尾不需要为资源指定特殊的行为,但在特殊情况下,为某些资源指定行为却是必要的。为了描述清楚,在行为前加上一个标准的`actions`
180180

181181
```
182182
/resources/:resource/actions/:action
@@ -190,14 +190,14 @@ $ curl -X POST https://service.com/apps \
190190

191191
#### 路径和属性要小写
192192

193-
为了和域名命名规则保持一致,使用小写字母和`-`分割路径名字,例如:
193+
为了和域名命名规则保持一致,使用小写字母并用`-`分割路径名字,例如
194194

195195
```
196196
service-api.com/users
197197
service-api.com/app-setups
198198
```
199199

200-
属性同样也要用小写字母,但是属性名字要用下划线`_`分割,因为这样在JavaScript语言中不用输入引号。 例如:
200+
属性也使用小写字母,但是属性名要用下划线`_`分割,以便在Javascript中省略引号。 例如:
201201

202202
```json
203203
service_class: "first"
@@ -222,7 +222,7 @@ $ curl https://service.com/apps/www-prod
222222
/orgs/{org_id}/apps/{app_id}/dynos/{dyno_id}
223223
```
224224

225-
推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。例如在上面的情况下,dyno属于app,app属于org可以表示为:
225+
推荐在根(root)路径下指定资源来限制路径的嵌套深度。使用嵌套指定范围的资源。在上述例子中,dyno属于app,app属于org可以表示为
226226

227227
```
228228
/orgs/{org_id}
@@ -291,7 +291,7 @@ $ curl https://service.com/apps/www-prod
291291
}
292292
```
293293

294-
这种方式尽可能的把相关联的资源信息内联在一起,而不用改变资源的结构,或者引入更多的字段 例如:
294+
这种方式尽可能的把相关联的资源信息内联在一起,而不用改变资源的结构,或者引入更多的字段例如:
295295

296296
```json
297297
{

0 commit comments

Comments
 (0)
0