node-cnb 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
|
|
6
6
|
node-cnb 是一个用于访问 [CNB API](https://api.cnb.cool/) 的 node 编写的 SDK。
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
## 安装
|
|
9
9
|
|
|
10
10
|
```shell
|
|
11
11
|
npm install node-cnb
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
## 使用
|
|
15
15
|
|
|
16
16
|
```typescript
|
|
17
17
|
import { getClient } from "node-cnb";
|
|
@@ -40,7 +40,7 @@ client.users.pinnedRepos.list({
|
|
|
40
40
|
})
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
## 方法路径
|
|
44
44
|
|
|
45
45
|
方法路径为由如下几个元素组成：
|
|
46
46
|
|
|
@@ -52,6 +52,6 @@ client.users.pinnedRepos.list({
|
|
|
52
52
|
|
|
53
53
|
`/{repo}/-/git/branches` 的路径下 get 请求的方法名为 `repo.git.branches.list`
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
`/{repo}/-/git/branches/{branch}` 的路径下 get 请求方法名为 `repo.git.branches.get`
|
|
56
56
|
|
|
57
57
|
对于此规则下方法路径仍然重复的 api，则单独定义在 [pathMethodMap.json](./pathMethodMap.json)
|