2013-03-29 8 views
10

È possibile automatizzare la documentazione dei percorsi in un'applicazione Spray?Automazione della documentazione dell'API REST per i percorsi

ad es. C'è forse un plugin SBT che genera un markdown che descrive ciò che sa delle rotte dello spray?

+2

Secondo https://groups.google.com/forum/#!topic/spray-user/0kxLzNRhnU4 non c'è molto disponibile. Tutte le soluzioni menzionate in quella discussione sono dichiarative. –

+0

Hai trovato un modo per documentare il tuo spray api? – dirceusemighini

risposta

3

Mi sono imbattuto in spray-swagger durante la ricerca della stessa cosa, ma non so esattamente cosa fa e in quale fase del progetto si trova.

+0

Funziona ma impone fastidiosi requisiti per riscrivere i percorsi in modo tale che siano tutti metodi (in cui, come è comune per le app Spray, definire percorsi come 'val's). È perché l'annotazione di 'ApiOperation' di Swagger ha come target solo i metodi. – expert

Problemi correlati