コンテンツにスキップ

メソッドタイプと一般的な動詞

動詞の例は、メソッドに関連する一般的に使用される動詞の小さな handful ですが、例にある動詞だけを使用することに制限されるべきではありません。

エンドポイントのタイトルを書くときは、動詞の原形を使用してください。例えば、「名前空間を作成する」。

エンドポイントの説明には、動詞の現在形を使用してください。例えば、「指定されたタイトルの下に名前空間を作成します」。

さらに、タイトルと説明に動詞としてメソッドタイプを使用することも問題ありません。例えば、メソッド GET を使用し、説明に「埋め込みコードを取得します」と含めることは許容されます。

メソッド目的動詞の例
GETリソースを取得する取得する、リストする、返す、ダウンロードする
POSTリソースを作成する作成する、監視する、挿入する、追加する
PUT既存のリソースを更新または作成する更新する、修正する、追加する
PATCH既存のリソースを部分的に修正する更新する、編集する、変更する
DELETEリソースを削除する削除する、取り除く、キャンセルする