導入ドキュメント
インターフェースの紹介
このインターフェースは、標準化されたレシピ分類リストを取得するために使用されます。 POST リクエスト呼び出しを通じて、システムは各カテゴリの名前 (「鳩」、「四川料理」など) を含む文字列配列を返し、開発者がコンテンツのインデックス付けの基礎を迅速に確立できるようにします。
該当するシナリオ
- コンテンツ管理システム: 食品ブログまたは APP 用の初期分類タグ ライブラリを提供します。
- 検索フィルタリングの最適化: フロントエンド フィルタの分類オプションを構築して、ユーザーの検索効率を向上させます。
- データの標準化: さまざまなソースからのレシピ データの分類基準を統一して、その後のデータ分析を容易にします。
リクエストと返品の手順
- リクエスト方法: POST
- リクエスト パス:
/v1/cookbook-type - 入力パラメータ: 現在のバージョンでは、特定のビジネス パラメータは必要ありません。リクエストを直接開始して、完全な分類セットまたはデフォルトの分類セットを取得できます。
- 戻り構造: JSON 配列。要素は文字列型です。たとえば、
["ハト", "家庭料理"]のように、各要素は特定のカテゴリ名を表します。
提案へのアクセス
- キャッシュ戦略: 機密データは比較的安定しているため、フロントエンドまたはサーバーでローカル キャッシュ (TTL を 24 時間に設定するなど) を実行して、不要な API 呼び出しを減らすことをお勧めします。
- 例外処理: フロントエンドが非表示のロジックを表示できるように、ネットワーク タイムアウトまたは空の配列が返された状況を適切に処理してください。
- データ マッピング: 返されたカテゴリ名を内部データベース ID とマッピングする必要がある場合があります。アクセスの初期段階で比較表を作成することをお勧めします。
実装サンプルコード
Shell、Python、Go、Java、PHP の呼び出し例をまとめ、既存プロジェクトに組み込みやすくしています。
リクエスト例
{}レスポンス例
[
"鸽子"
]リクエスト項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | サンプル値 |
|---|---|---|
| type | string | object |
| properties | object | {...} |
レスポンス項目
以下の項目はサンプル JSON から自動抽出した参考情報です。
| パス | 型 | サンプル値 |
|---|---|---|
| type | string | array |
| items | object | {...} |
| items.type | string | string |
| items.example | string | 鸽子 |
| example | array | "鸽子" |
| example[] | string | 鸽子 |