Ich habe einen Rails-basierten Server, auf dem mehrere REST-Services ausgeführt werden, und eine Rails-basierte Web-UI, die mit ActiveResource auf dem Server interagiert. Derselbe Server wird von anderen Clients (z. B. Mobiltelefon) verwendet. Ich muss die Dokumentation für die REST-Schnittstelle generieren. Ich muss Service-URL, Eingabe / Ausgabe und Fehlerdokumentstruktur für jeden Service zur Verfügung stellen.
Im Idealfall möchte ich einen Interceptor auf der Serverseite verwenden, der den Dienst basierend auf dem vorhandenen Datenverkehr dokumentiert. Ich frage mich, ob es ein Juwel dafür gibt.
Wenn Sie den REST-Architekturstil anwenden, müssen Sie Ihre Schnittstelle nicht dokumentieren.
Der Vertrag zwischen Client und Server wird durch den verwendeten Medientyp festgelegt. Wenn Sie weitere zusätzliche Dokumentation benötigen, sind Sie nicht RESTful.
Anstatt sich darum zu kümmern, Ihren Service zu dokumentieren, sollten Sie Ihre gesamte anschauliche Arbeit in die Dokumentation Ihrer Medientypen investieren. Um die Clients für Ihren Server zu implementieren, ist nur das Wissen über Medientypen erforderlich.
Tags und Links ruby-on-rails rest activeresource