Génération de la documentation

Enunciate

Pour générer la documentation à partir de la javadoc, le projet utilise Enunciate.

Doc: https://github.com/stoicflame/enunciate

Generation de la documentation

La documentation est générée par Maven en lançant un build avec le profil docs

mvn clean compile package -Plocal,docs

Elle est générée dans src/main/webapp/docs et donc accessible à l'adresse http://localhost:8080/rest-quickstart/docs

Annotations utiles

Liste complète: https://github.com/stoicflame/enunciate/wiki/Enunciate-Specific-Annotations

@TypeHint

Cette annotation permet de spécifier le type d'un paramètre ou d'une réponse. Indispensable si la méthode renvoie un objet Response. Elle peut également être utilisée sur un paramètre de méthode (par exemple si le paramètre est de type String)

@GET
@TypeHint(value = User.class)
public Response sayHello() {
	return Response.entity("Hello").build();
}

@HTTP

Annotation de JAVADoc. Permet d'indiquer une description pour un code de retour.

/**
 * Says "Hello".
 * 
 * @HTTP 200 Says Hello
 * @HTTP 500 Something happened
 */