API 仕様書
開発者向けに認証方式、共通仕様、エラーコード、各 API のパラメータと例を明記し、ドキュメントだけで連携できるようにします。
プロンプト
会員ポイントシステムの外部公開 API の仕様書を作成してください。目的：パートナーの開発者がドキュメントだけで連携を完了できるようにすること。要件：各環境の URL、認証方式、共通仕様（リクエスト形式、ページング、冪等性、レート制限、日時形式）を記載し、エラーコード表と API 一覧を示し、各 API のメソッドとパス、リクエストパラメータ表、レスポンス項目表、成功時と失敗時の例を挙げ、コールバックの署名検証とリトライ方針、変更履歴も付けてください。型と必須項目は正確に、キーはプレースホルダーで、簡潔に。
- 出典
- Ofox
使い方
- 1
「同じものを作る」を押す
Ofox Chat が開き、この文書の構成があらかじめ用意されています。未ログインの場合は先にログインしてください。
- 2
自分用にアレンジ
プロンプトのハイライト部分を書き換えて、自分の内容に差し替えましょう。
- 3
送信して生成
送信すると Ofox Chat が文書を書き上げ、そのままダウンロードできます。気になる点は会話を続けて直せます。
よくある質問
どんな形式のファイルができますか？
構成の整った、ダウンロードできる文書（Word または PDF）です。チャット上のテキストだけでは終わりません。
資料を用意する必要はありますか？
用意しなくてもそのまま送信でき、Ofox Chat がテンプレートに沿ってまず一版を書きます。背景情報やデータ、既存の文書（貼り付け、または PDF・Word などのアップロード）も一緒に渡すと、より実情に合った内容になります。
プロンプトは編集できますか？
はい。プロンプトは Ofox Chat の入力欄に入ります。送信前に自分のテーマに置き換えたり、要件を足したり、不要な部分を消したりできます。
プロンプトはそのままコピーして使えますか？
はい。プロンプトカード右上の「コピー」でプレーンテキストを取得でき、ほかの AI ライティングツールでも使えます。
似ている作例
開発のプロンプトをもっと見る- 技術設計書システムや機能の実装方針を、アーキテクチャ、データモデル、インターフェース、代替案の比較で示し、性能・リスク・切り戻しを評価します。開発
- 障害振り返りレポート本番障害をタイムラインで再現し、影響範囲を定量化して根本原因を突き止め、担当者と期限付きの再発防止策をまとめます。開発
- 技術選定レポート業務要件から評価軸と重みを定め、候補技術を根拠付きで比較・採点し、推奨案とリスク、導入計画を示します。開発
- テスト計画書リリースやプロジェクトについて、何を・どう・どの環境で・どこまでテストするかを明確にし、QA・開発・製品の認識をそろえます。開発
- リリース手順書リリース作業を、事前チェック、手順、リリース後の確認、明確な判断基準付きの切り戻しまで、順番に実行できる手順書にまとめます。開発
- コーディング規約チームで統一するコーディング規約を、必須と推奨に分けて、命名・構成・エラー処理・セキュリティ・レビューのルールと良い例・悪い例でまとめます。開発
- データベース設計書データ層の設計を、ER 図、テーブル定義と制約、インデックスごとの対象クエリ、データ量見積もり、アーカイブ方針まで整理し、テーブル作成とレビューの拠り所にします。開発
- システム移行計画書システムやデータの移行を計画し、現状の棚卸し、移行方式の選定、データ同期と検証、段階的な切り替え、各段階の切り戻し手順をまとめます。開発
- 性能テスト報告書性能テストの結果を、目標に対するシナリオ別のスループット、応答時間のパーセンタイル、リソース使用率で示し、ボトルネックを特定して、リリース可否と容量の提言をまとめます。開発
- セキュリティ評価書システムのセキュリティ評価を、範囲の定義と脅威モデリング、指摘事項ごとのリスクレベルと根拠、修正提案、修正・再テスト計画まで文書にまとめます。開発
自分のアイデアがあるなら、今すぐ作ろう
欲しい画像をひと言で伝えるだけ。Ofox Chat がゼロから生成します。