AIプロンプト詳細
実際のビジネス課題をより速く解決するために設計された、すぐに使える実践的なAIプロンプト。明確なステップ、実証済みのフレームワーク、即実行可能なアクションを含みます。
リリース前にAPIエンドポイントを検証・改善する
不明瞭なレスポンス、不足しているフィールド、エッジケースを、リリース前に特定して修正します。
解決する課題
技術的には動作していても、フロントエンドチームや外部ユーザーを混乱させるAPIをリリースしてしまうことがあります。不十分なエラーケースや一貫性のない命名は、バグやサポートコストの増加を招きます。
コントラクトレベルの検証
利用者（コンシューマー）の視点でAPIをレビューします。
エラー優先思考
現実世界の失敗シナリオを早期に表面化させます。
統合しやすい出力
使いやすく、デバッグしやすいAPIを実現します。
AIプロンプト手順
シニアバックエンドエンジニアおよびAPIレビュアーとして活動してください。
APIエンドポイント（メソッド + パス）：[例：POST /api/orders]
エンドポイントの目的：[何を行うものか]
リクエストペイロード（JSON）：[貼り付け]
成功時のレスポンス例（JSON）：[貼り付け]
既知のエラーケース（あれば）：[リストまたはなし]
あなたのタスク：
1) エンドポイントの目的が規約から明確であるか確認する。
2) 不足している、または曖昧なリクエストフィールドを特定する。
3) レスポンス構造の一貫性と明確さをレビューする。
4) ステータスコードを伴う少なくとも3つの現実的なエラーレスポンスを提案する。
5) 名前付けや構造に関する小さな改善を推奨する。
6) クリーンで改善されたレスポンス例を出力する。
フィードバックは実用的かつ実装可能なものにしてください。API全体を再設計しないでください。
期待される成果
明確な改善提案、不足していたエラーケース、および洗練されたレスポンス例を受け取ることができます。
実装ステップ
エンドポイントの詳細を貼り付け
リクエスト、レスポンス、目的の情報を追加します。
3分AIのフィードバックを確認
修正案や不足しているエッジケースをチェックします。
3分リリース前に適用
リリース前にエンドポイントやドキュメントを更新します。
5分プロンプト概要
1つのエンドポイントが整ったら、次はAPI全体を検証し、コントラクトチェックの自動化を検討しましょう。
このプロンプトをメールで受け取る
この AI プロンプトをコピーしやすい整った形式で受信箱に届けます。いつでも使えます。