Sollte eine API?

1. Was sollte die API -Dokumentation enthalten?
2. Was sollte eine ideale API -Dokumentation Cover?
3. Wie schreibe ich ein API -Anforderungsdokument??

Was sollte die API -Dokumentation enthalten?

Die API -Dokumentation sollte ein Beispiel für jeden Aufruf, jeden Parameter und Antworten für jeden Anruf liefern. Es sollte Codeproben für häufig verwendete Sprachen wie Java, JavaScript, PHP und Python enthalten. Die Dokumentation sollte eine Erklärung für jede API -Anforderung und Beispiele für Fehlermeldungen liefern.

Was sollte eine ideale API -Dokumentation Cover?

Die Grundlage Ihrer API -Dokumentation ist eine klare Erklärung für jeden Anruf und jeden Parameter. Als Minimum sollten Sie im Detail beschreiben: Was jeder Aufruf in Ihrer API tut. Jeder Parameter und alle möglichen Werte, einschließlich ihrer Typen, Formatierung, Regeln und ob sie erforderlich sind oder nicht.

Wie schreibe ich ein API -Anforderungsdokument??

Die detaillierten Anforderungen für die API verstehen und klar artikulieren. Stellen Sie sicher, dass es eine Übereinstimmung zwischen den wichtigsten Akteuren gibt, bevor die Entwicklung beginnt. Trennende Funktionen von nicht funktionierenden Anforderungen und entwickeln sich nur zu den funktionalen Anforderungen. Durch den API -Entwicklungsprozess wiederholen.