生成AIプロンプト研究所チャプロ
  • エンジニア検定
  • 記事
  • セミナー
  • プロンプト
  • 便利サービス
無料登録
menu
ホームプロンプトフリマアプリのAPI設計書を作成するプロンプト
通常システム開発

フリマアプリのAPI設計書を作成するプロンプト

シゲッティ

フリマアプリ開発のためのAPI設計書作成ガイド

フリマアプリの全機能をサポートするためのAPI設計書を作成することで、開発チームが効率良く作業を進められるようにする。

このプロンプトは、フリマアプリの開発プロジェクトにおいて必要なAPIの機能要件をもとに、技術者やプロジェクトマネージャーが具体的に設計書を作成できるように指示する内容を含んでいます。設計書にはユーザー認証、商品管理、取引処理、評価・レビューシステム、通知機能、データベース設計、セキュリティとパフォーマンス要件などの詳細が含まれるべきです。

プロンプト本文

#前提条件:
- タイトル: フリマアプリAPI設計書作成
- 依頼者条件: フリマアプリを開発したい技術者やプロジェクトマネージャー
- 制作者条件: API設計とフリマアプリの機能に精通したエンジニア
- 目的と目標: フリマアプリを開発するための具体的なAPI設計書を作成すること
- リソース: API設計に関するドキュメント、フリマアプリの機能要件、既存のフリマアプリのリサーチ
- 評価基準: 設計書がフリマアプリの全機能をカバーし、開発チームが実装に使用できること
- 明確化の要件:
- ユーザー認証と認可のAPI設計
- 商品登録、検索、閲覧のAPI設計
- 購入、取引のAPI設計
- 評価・レビューのAPI設計
- 通知機能のAPI設計
- データベースの設計と連携
- セキュリティおよびパフォーマンスの考慮


# 実行指示:
{機能要件}を基に、
明確かつ具体的なスタイルで、専門的なトーンで、
APIを設計してください。
{参考フォーマット}を参考にして書いてください。


機能要件=“

”

参考フォーマット="
#フリマアプリのAPI設計書

##概要

APIについて仕様を説明します。

| ホスト | プロトコル | Version | データ形式 |
|----------------------------|--------------------------------------|--------------------------------------|--------------------------------------|


###URL

###アクセストークン
全てのAPIリクエストに、APIアクセストークンを Authorizationリクエストヘッダに付与してください。

###ステータスコード

下記のコードを返却します。

| ステータスコード | 説明 |
|----------------------------|--------------------------------------|

###利用制限

##1. 各機能のAPI仕様

##2. セキュリティおよびパフォーマンス

###2.1 セキュリティ

###2.2 パフォーマンス
"
機能要件
運営会社
利用規約
プロンプトエンジニア一覧
プロンプトエンジニア育成講座
©2025 生成AIプロンプト研究所「チャプロ」 All rights reserved.