Generating documentation for Java Jersey framework

After searching a while, there is no easy tools for making beautifull documentation for Java Jersey.

It’s a mess, as jersey is a great framework. So I build a simple project, in three tiny project, to help me, and of course you, to build REST documentation:

  • jersey-doc-annotation: As the system works on compiled version, we loose javadoc… This project helps to create few annotation to retrieve some REST specific documentation.

    Note: This project is optional, it just allow to make add more data to documentation, it’s not mandatory at all.

  • jersey-doc-generator: The main project, builded using java and maven, and generating a raw JSON from a given project resource…

  • jersey-doc-template: after outputting the raw data from jersey-doc-generator, it’s time to present them in a simple, and good looking template. This project is here for that.

With thoose, we cover the full process of generating documentation for such tool as Jersey. Feel free to use them and make any comments here if you get any trouble!

Publicités

Un commentaire

  1. Pingback: Criando um WebService Restful em Java – Desenvolva Sistemas

Laisser un commentaire

Entrez vos coordonnées ci-dessous ou cliquez sur une icône pour vous connecter:

Logo WordPress.com

Vous commentez à l'aide de votre compte WordPress.com. Déconnexion / Changer )

Image Twitter

Vous commentez à l'aide de votre compte Twitter. Déconnexion / Changer )

Photo Facebook

Vous commentez à l'aide de votre compte Facebook. Déconnexion / Changer )

Photo Google+

Vous commentez à l'aide de votre compte Google+. Déconnexion / Changer )

Connexion à %s

%d blogueurs aiment cette page :