Ich werde bald eine RESTful-API entwerfen, daher muss ich sie beschreiben, damit andere Benutzer damit beginnen können, Clients zu implementieren, die sie verwenden.

Ich habe mich ein bisschen umgesehen, aber leider keine standardisierte Form zur Beschreibung von webbasierten RESTful-Diensten gefunden. Was ich suche, ist so etwas wie JavaDoc, obwohl es nicht aus irgendeiner Art von Code generiert werden muss. Ich spreche auch nicht über etwas wie WADL, ich möchte lieber eine von Menschen lesbare Dokumentation, die ich aushändigen kann.

Aufgrund der Art der webbasierten RESTful-Dienste sollte es recht einfach sein, eine Dokumentation zu standardisieren. Es sollte nur verfügbare Ressourcen, entsprechende URIs, zulässige Methoden und Inhaltstypen auflisten und die verfügbaren Aktionen beschreiben. Haben Sie hierzu Vorschläge?

Vielen Dank im Voraus und Grüße