Wie schreibe ich ein PHP-Schnittstellendokument?

1. Wie HTTP Informationen überträgt

URL

Header

Körper: einschließlich Anforderungstext, Antworttext

2. Separate gemeinsame Informationen

Im Allgemeinen sind die Informationen in Kopfzeilen universell und können im Voraus als Standardparameter angegeben werden

3. Parameterausdrücke im Pfad

Die Parameterausdrücke in der URL verwenden die Form eines Schnurrbarts und die Parameter sind in doppelte geschweifte Klammern {{paramName}}

eingeschlossen Verwandte Empfehlungen: „php-Einführungs-Tutorial“

Zum Beispiel:

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

4. Datenmodelldefinition

Datenmodelldefinition Beinhaltet:

·Pfad- und Abfragezeichenfolgenparametermodell

·Anforderungskörperparametermodell

·Antwortkörperparametermodell

Mindestdatensatz des Datenmodells:

Name

Ist es notwendig

Beschreibung

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

Einige Dokumente fügen möglicherweise Feldtypen hinzu, aber ich denke, das ist unnötig. Es wird angenommen, dass die über HTTP übertragenen Daten häufig serialisiert werden müssen und die meisten Datentypen Zeichenfolgen sind. Einige spezielle Typen, z. B. Zeichenfolgen vom Aufzählungstyp, können in der Beschreibung beschrieben werden.

Außerdem wird dringend empfohlen, Tabellen zur Darstellung des Datenmodells zu verwenden.

Das obige ist der detaillierte Inhalt vonWie schreibe ich ein PHP-Schnittstellendokument?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!