REST und HTTP, 3rd Edition

12 Dokumentation

Jedes System erfordert eine Dokumentation, damit es von den Beteiligten korrekt verwendet werden kann – daran ändert auch der Einsatz der REST-Prinzipien nichts. Dokumentation richtet sich dabei an Endanwender, die ein System über eine Benutzerschnittstelle nutzen, ebenso wie an die Entwickler von Clientanwendungen, die eine angebotene Funktionalität programmatisch verwenden möchten. Allerdings gibt es einige Besonderheiten, die sich aus der Vereinigung von Dokumenten und dynamischen Diensten in einem einzigen konzeptionellen Modell ergeben:

• Innerhalb der Webarchitektur haben Dokumente – also auch die Dokumente, die Ihre Ressourcen beschreiben – selbst den Status eigenständiger Ressourcen.

• Die Navigation innerhalb der Dokumentation, ...