ohne Leser zu überfordern
Gute GraphQL-Dokumentation ist keine statische Datei, sondern lebt im Schema selbst – ergänzt durch Introspection-Tools, lebende Beispielqueries, Deprecation-Strategien und einen Schema-Registry-Workflow, der Änderungen kommunizierbar macht.
Inhaltsverzeichnis
- 1. Das Dokumentationsproblem bei GraphQL
- 2. @doc-Direktiven: Dokumentation im Schema selbst
- 3. Introspection als Dokumentationsgrundlage
- 4. Tools: GraphiQL, Apollo Studio und Hive im Vergleich
- 5. Lebende Beispielqueries als Dokumentationsform
- 6. Deprecation: alte Felder kommunizieren ohne Schock
- 7. Schema-Registry: Dokumentation im Team
- 8. Magento-Schema dokumentieren: wo anfangen
- 9. Zusammenfassung
- 10. Vergleich: Dokumentationsstrategien für GraphQL
- 11. FAQ