エンドポイントの作成
エンドポイントとは？
| コンポーネント | 説明 | 例 |
|---|---|---|
| HTTP メソッド | 実行するアクション | GET, POST, PUT, DELETE |
| パス | ベース URL からの相対 URL パス | /users/{id} |
| パラメータ | パス、クエリ、ヘッダー、またはボディのパラメータ | id（パスパラメータ） |
| リクエストボディ | リクエストとともに送信されるデータ（POST/PUT の場合） | JSON スキーマ |
| レスポンス | 想定されるレスポンス形式とステータスコード | 200 OK, 404 Not Found |
重要な概念
エンドポイントの作成
前提条件
クイックスタート：基本的なエンドポイント作成
1.
2.
エンドポイントの作成方法
| 方法 | 使用する場面 | 手順 |
|---|---|---|
| 手動作成 | ゼロから開始する場合 | 1. フォルダーを右クリック →「New Endpoint」 2. メソッドとパスを入力 3. パラメータとレスポンスを定義 |
| コードからインポート | 既存の API コードがある場合 | 1. 「Import」機能を使用 2. OpenAPI/Swagger ファイルをアップロード 3. モジュールにマッピング |
| リクエストから | 既存の API をテストする場合 | 1. まずリクエストを送信 2. 「Save」をクリック 3. 仕様を調整 |
| 既存のものを複製 | 類似したエンドポイントの場合 | 1. エンドポイントを右クリック →「Duplicate」 2. パスとパラメータを変更 |
エンドポイント詳細の指定
基本情報
パラメータ
パスパラメータ
GET /users/{userId}/posts/{postId}| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
userId | integer | はい | 一意のユーザー識別子 |
postId | integer | はい | 投稿識別子 |
クエリパラメータ
| パラメータ | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
limit | integer | いいえ | 10 | 返す結果の数 |
offset | integer | いいえ | 0 | スキップする結果の数 |
status | string | いいえ | active | ステータスでフィルタリング |
リクエストボディ（POST/PUT の場合）
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User's full name"
},
"email": {
"type": "string",
"format": "email",
"description": "User's email address"
}
},
"required": ["name", "email"]
}レスポンス
成功レスポンス（200 OK）
{
"id": 123,
"name": "John Doe",
"email": "john@example.com",
"createdAt": "2023-01-15T10:30:00Z"
}エラーレスポンス
| ステータスコード | 説明 | スキーマ |
|---|---|---|
400 | Bad Request | エラーの詳細 |
401 | Unauthorized | 認証エラー |
404 | Not Found | リソースが見つかりません |
500 | Internal Server Error | サーバーエラーの詳細 |
Modified at 2026-06-11 07:06:02