Resteasy - genera documentazione REST da Javadoc e annotazioni

Question

Vorrei trovare un modo per generare una buona documentazione dell'API REST dal codice java (WADL o HTML) - basato su annotazioni JAXB, JAX-RS e commenti di documenti java (senza doclet per favore).

Qui è il mio ambiente di progetto

• Primavera, non XML annotazioni solo
• Rest-facile come fornitore di REST
• JAXB e JAX-RS annotazioni
• Tipo Mime per l'API riposo in JSON

Answer 1

Prova Enunciate.

Enuncia è un motore per migliorare notevolmente l'API del servizio Web Java. È semplice. Sviluppa la tua API dei servizi Web utilizzando le tecnologie Java standard e allega Enunciate al tuo processo di compilazione. All'improvviso, l'API del servizio Web presenta alcune caratteristiche piuttosto impressionanti:

• Documentazione HTML completa dei tuoi servizi, raschiata dal tuo JavaDocs.
• Librerie lato client (ad esempio Java, .NET, iPhone, Ruby, Flex, AJAX, GWT, ecc.) Per gli sviluppatori che desiderano interfacciarsi con la propria API.
• Interface Definition documenti (ad esempio WSDL, WADL, XML Schema, etc.)
• Ecc

Answer 2

Le API del compilatore Java consentono di scrivere codice che analizza l'origine Java ed esegue la propria elaborazione.

Ecco uno instructional article, che include informazioni sull'analisi delle annotazioni.

Immagino che sia possibile estrarre le informazioni non elaborate necessarie utilizzando queste API. Tuttavia questo produrrà fatti sintattici - gli URL di REST e le azioni e i parametri, un utente trarrebbe anche beneficio da una spiegazione aggiuntiva, che l'autore del servizio potrebbe (dovrebbe?) Fornire in Documento Java.

la soluzione completa potrebbe essere quella di analizzare sia l'annotazione che il documento java e combinare i due.

Answer 3

In alternativa al Enunciate, si potrebbe anche prendere in considerazione MireDot. È cresciuto da uno strumento che utilizziamo all'interno della nostra azienda ed è gratuito da utilizzare per progetti open source. Fa esattamente ciò che descrivi: combina le annotazioni jaxrs e i commenti javadoc esistenti per generare una pausa. Funziona come un plugin Maven che devi solo aggiungere al tuo progetto. Le annotazioni Jaxb non sono ancora supportate al momento della scrittura, ma lo strumento è in fase di sviluppo attivo e selezioniamo le funzionalità da implementare in base a suggerimenti/richieste/feedback.