REST WADL: Irgendwelche Stilrichtlinien oder gute Beispiele?

Question

Es gibt viele hervorragende Beispiele und Leitlinien (siehe Lit. [1]) für Java-Code gut javadoc Schreiben

wir unsere REST-Schnittstellen über WADL Dokumentation mit Restlet

http://wiki.restlet.org/docs_2.0/13-restlet/28-restlet/72-restlet.html

dass Tutorial Zitiert wir fügen Code wie ... hinzu

@Override 
    protected void describeDelete(MethodInfo info) { 
     info.setDocumentation("Delete the current item."); 

     RepresentationInfo repInfo = new RepresentationInfo(); 
     repInfo.setDocumentation("No representation is returned."); 
     repInfo.getStatuses().add(Status.SUCCESS_NO_CONTENT); 
     info.getResponse().getRepresentations().add(repInfo); 
    } 

Gibt es Codierungsstandards oder Beispiele für gute prägnante WADL. e, g, wir möchten keine Informationen kopieren, die im HTTP-Verb oder der URL enthalten sind.

Ref 1. Wie schreibe ich Doc Kommentare für das Javadoc Tool. Ich kann die URL hinzufügen, wie ich neue Benutzer sind, aber ich meine die Richtlinien bei
www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 1

Der einzige Teil eines RESTful Systems, das Benötigt zusätzliche Dokumentation ist benutzerdefinierte Medientypen und benutzerdefinierte Link-Beziehungen.

Denken Sie daran, welche Dokumentation haben Sie den Webbrowser-Anbietern zur Verfügung gestellt, damit Benutzer auf Ihre Unternehmenswebsite zugreifen können?