Comment écrire un document d'interface PHP

1. Comment HTTP transporte les informations

url

en-têtes

corps : y compris le corps de la requête, corps de réponse

2. Informations communes séparées

De manière générale, les informations contenues dans les en-têtes sont universelles et peuvent être indiquées à l'avance comme paramètres par défaut

3. Expressions de paramètres dans le chemin

Les expressions de paramètres dans l'URL utilisent la forme d'une moustache et les paramètres sont entourés de doubles accolades {{paramName}}

Recommandations associées : "Tutoriel d'introduction à php"

Par exemple :

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

4. Définition du modèle de données

Définition du modèle de données. Comprend :

·Modèle de paramètres de chemin et de chaîne de requête

·Modèle de paramètres de corps de requête

·Modèle de paramètres du corps de réponse

Ensemble de données minimum du modèle de données :

Nom

Est-ce nécessaire

Description

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

Certains documents peuvent ajouter des types de champs, mais je pense que cela est inutile. On pense que les données transmises par HTTP doivent souvent être sérialisées et que la plupart des types de données sont des chaînes. Certains types spéciaux, tels que les chaînes de type énumération, peuvent être décrits dans la description.

De plus : il est fortement recommandé d'utiliser des tableaux pour représenter le modèle de données.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!