Wie schreibe ich eine gute Schnittstellendokumentation?

In diesem Artikel erfahren Sie hauptsächlich, wie Sie ein gutes Schnittstellendokument schreiben. Ich hoffe, er kann Ihnen beim Schreiben eines guten Schnittstellendokuments helfen.

1 Wie HTTP Informationen überträgt

• URL

• Header

• Körper : einschließlich Anforderungstext, Antworttext

2 Trennung allgemeiner Informationen

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

3 Parameterausdruck im Pfad

Der Parameterausdruck in der URL verwendet die Form eines Schnurrbarts und die Parameter werden in doppelte geschweifte Klammern eingeschlossen {{paramName}}

Zum Beispiel:

• /api/user/{{userId}}

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

4 Datenmodelldefinition

Die Datenmodelldefinition umfasst:

• Pfad- und Abfragezeichenfolgenparametermodell

• Anforderungskörperparametermodell

• Antwortkörperparametermodell

Mindestdatensatz des Datenmodells:

• Name

• Ist es notwendig

• Erklärung

„Minimum Data Set“ (MDS) bezieht sich auf ein besseres Verständnis eines Forschungsobjekts durch die Erfassung der geringsten Menge Der Kern der Merkmale oder des Status einer Sache oder eines Auftrags besteht darin, eine Reihe optimierter und praktischer Datenindikatoren für das beobachtete Objekt festzulegen. Das Konzept minimaler Datensätze hat seinen Ursprung im medizinischen Bereich in den USA. Die Generierung des Mindestdatensatzes ergibt sich aus der Notwendigkeit des Informationsaustauschs, beispielsweise der Notwendigkeit des Informationsaustauschs zwischen übergeordneten und untergeordneten Qualitäts- und technischen Überwachungsabteilungen, zwischen Unternehmen und Qualitäts- und technischen Überwachungsabteilungen sowie zwischen Qualitäts- und technischen Überwachungsabteilungen und den öffentlich.

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: 数据模型非常建议使用表格来表现.

Gib mir eine Kastanie

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