REST WADL: Toutes les directives de style ou de bons exemples?

Question

Il y a beaucoup d'excellents exemples et des lignes directrices (voir la référence [1]) pour écrire un bon javadoc pour Java Code

Nous documentons nos interfaces REST via WADL en utilisant Restlet

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

citant ce tutoriel nous ajoutons du code comme ...

@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); 
    } 

Existe-t-il des standards de codage ou des exemples de bonne WADL succincte? Par exemple, nous ne voulons pas dupliquer les informations implicites dans le verbe HTTP ou l'URL.

Réf 1. Comment écrire des commentaires de Doc pour l'outil Javadoc. Je ne peux pas ajouter l'URL comme je suis un nouvel utilisateur, mais je veux dire les lignes directrices à
www.oracle.com/technetwork/java/javase/documentation/index-137868.html

Answer 1

La seule partie d'un système qui RESTful a besoin de toute documentation supplémentaire est les types de médias personnalisés et les relations de liens personnalisés. Pensez-y de cette façon, quelle documentation avez-vous fournie aux fournisseurs de navigateurs Web pour que les utilisateurs puissent accéder à votre site Web d'entreprise?