PHPインターフェースドキュメントの書き方

#1. HTTP による情報の伝達方法

url

headers

body: リクエスト本文を含む, レスポンスボディ

2. 別途の共通情報# 一般的に、ヘッダー内の情報は普遍的なものであり、デフォルトパラメータとして事前に記述することができます

3. パス内のパラメーター式

URL 内のパラメーター式は、mustache の形式を使用しており、パラメーターは二重中括弧 {{paramName}}

# で囲まれています。 # #関連する推奨事項: 「

php Getting Started Tutorial

」

例:

/api/user/{{userId}}
/api/user/{{userType}}?age={{age}}&gender={{gender}}

4. データ モデルの定義

データ モデル定義 次のものが含まれます:

#パスおよびクエリ文字列パラメータ モデル

リクエスト本体パラメータ モデル

·

応答本文パラメーター モデルデータ モデルの最小データ セット:

名前

必須かどうか

説明

“最小数据集”（MDS）是指通过收集最少的数据，较好地掌握一个研究对象所具有的特点或一件事情、一份工作所处的状态，
其核心是针对被观察的对象建立起一套精简实用的数据指标。最小数据集的概念起源于美国的医疗领域。最小数据集的产生源于信息
交换的需要，就好比上下级质量技术监督部门之间、企业与质量技术监督部门之间、质量技术监督部门与社会公众之间都存在着信息
交换的需求。

ドキュメントによってはフィールド タイプを追加する場合がありますが、これは不要だと思います。 HTTP によって送信されるデータはシリアル化する必要があることが多く、ほとんどのデータ型は文字列であると考えられています。列挙型文字列などの一部の特殊な型を説明に記述することができます。

さらに: データ モデルを表現するにはテーブルを使用することを強くお勧めします。

以上がPHPインターフェースドキュメントの書き方の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。