Skip to content

Commit b8b3d1d

Browse files
authored
docs(rest-api): add the desired method of endpoint [skip ci]
1 parent 6eeacbc commit b8b3d1d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

rest-api/docs/api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Schema 是這個 API 回應的資料結構。
88
- 使用 [JSON Schema (Draft-07)](https://json-schema.org) 定義。
99

10-
## `/`:檢視目前 API 的一般性資訊
10+
## `GET /`:檢視目前 API 的一般性資訊
1111

1212
這個 Endpoint 除了代表著這個 API 是否可以接受請求,亦可從中檢視目前 API 的一般性資訊。
1313

@@ -32,7 +32,7 @@ curl --location --request GET '<api_address>/'
3232
}
3333
```
3434

35-
## `/docs/…`:本 REST API 的文件
35+
## `GET /docs/…`:本 REST API 的文件
3636

3737
這個 Endpoint 包含適用於本 REST API 版本的文件。
3838

@@ -52,12 +52,12 @@ curl --location --request GET '<api_address>/docs/readme'
5252

5353
回傳此文件的純文字版本。
5454

55-
## `/schema/…`:擺放各 API 回應的資料結構
55+
## `GET /schema/…`:擺放各 API 回應的資料結構
5656

5757
請參閱各 API 之〈⋯⋯的 Schema 路徑〉一節。相關範例請見 codebase 根目錄中
5858
`src/schema/v1` 的 JSON 檔案。
5959

60-
## `/api/v1/search`:搜尋音樂並取回本資源的識別物件
60+
## `POST /api/v1/search`:搜尋音樂並取回本資源的識別物件
6161

6262
這個 Endpoint 為 UNM (Rust) Executor 的封裝。
6363

@@ -142,7 +142,7 @@ curl --location --request POST '<api_address>/api/v1/search' \
142142
}
143143
```
144144

145-
## `/api/v1/retrieve`:取回某個資源
145+
## `POST /api/v1/retrieve`:取回某個資源
146146

147147
這個 Endpoint 為 UNM (Rust) Executor 的封裝。
148148

0 commit comments

Comments
 (0)