三つ星シェフGPTくん · Acciones GPT

{
  "openapi": "3.0.0",
  "info": {
    "title": "楽天レシピカテゴリランキングAPI",
    "version": "1.0.0",
    "description": "楽天レシピのカテゴリ別ランキングを返すAPI"
  },
  "servers": [
    {
      "url": "https://app.rakuten.co.jp/services/api"
    }
  ],
  "paths": {
    "/Recipe/CategoryList/20170426": {
      "get": {
        "summary": "楽天レシピのカテゴリ一覧を取得",
        "operationId": "getCategoryList",
        "parameters": [
          {
            "name": "applicationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "アプリケーションID",
            "example": 1031253256369991400
          },
          {
            "name": "format",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "json",
                "xml"
              ]
            },
            "description": "レスポンスのフォーマット（JSONまたはXML）"
          }
        ],
        "responses": {
          "200": {
            "description": "成功時のレスポンス",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CategoryListResponse"
                }
              }
            }
          }
        }
      }
    },
    "/Recipe/CategoryRanking/20170426": {
      "get": {
        "summary": "指定されたカテゴリIDに基づいて人気レシピを取得",
        "operationId": "getCategoryRanking",
        "parameters": [
          {
            "name": "applicationId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "アプリケーションID",
            "example": 1031253256369991400
          },
          {
            "name": "categoryId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "レシピのカテゴリID"
          },
          {
            "name": "format",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "json",
                "xml"
              ]
            },
            "description": "レスポンスのフォーマット（JSONまたはXML）"
          }
        ],
        "responses": {
          "200": {
            "description": "成功時のレスポンス",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CategoryRankingResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CategoryListResponse": {
        "type": "object",
        "properties": {
          "result": {
            "type": "object",
            "properties": {
              "large": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Category"
                }
              },
              "medium": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Category"
                }
              },
              "small": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Category"
                }
              }
            }
          }
        }
      },
      "Category": {
        "type": "object",
        "properties": {
          "categoryId": {
            "type": "string",
            "description": "カテゴリID"
          },
          "categoryName": {
            "type": "string",
            "description": "カテゴリ名"
          },
          "categoryUrl": {
            "type": "string",
            "format": "uri",
            "description": "カテゴリURL"
          },
          "parentCategoryId": {
            "type": "string",
            "description": "親カテゴリID"
          }
        }
      },
      "CategoryRankingResponse": {
        "type": "object",
        "properties": {
          "result": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Recipe"
            }
          }
        }
      },
      "Recipe": {
        "type": "object",
        "properties": {
          "recipeId": {
            "type": "string",
            "description": "レシピID"
          },
          "recipeTitle": {
            "type": "string",
            "description": "レシピタイトル"
          },
          "recipeUrl": {
            "type": "string",
            "format": "uri",
            "description": "レシピURL"
          },
          "foodImageUrl": {
            "type": "string",
            "format": "uri",
            "description": "画像のURL(サイズ:一般)"
          },
          "mediumImageUrl": {
            "type": "string",
            "format": "uri",
            "description": "画像のURL(サイズ:中)"
          },
          "smallImageUrl": {
            "type": "string",
            "format": "uri",
            "description": "画像のURL(サイズ:小)"
          },
          "pickup": {
            "type": "integer",
            "description": "ピックアップレシピ（0：通常レシピ、1：編集部おすすめレシピ）"
          },
          "shop": {
            "type": "integer",
            "description": "ユーザー区分（0：一般、2：楽天市場店舗）"
          },
          "nickname": {
            "type": "string",
            "description": "レシピ投稿者"
          },
          "recipeDescription": {
            "type": "string",
            "description": "レシピを考えた人のコメント"
          },
          "recipeMaterial": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "材料名の一覧"
          },
          "recipeIndication": {
            "type": "string",
            "description": "調理時間目安"
          },
          "recipeCost": {
            "type": "string",
            "description": "費用の目安"
          },
          "recipePublishday": {
            "type": "string",
            "description": "レシピ公開日"
          },
          "rank": {
            "type": "integer",
            "description": "ランキング順位"
          }
        }
      }
    }
  }
}