2015-05-05 13 views
11

Ci sono dei plugin (simili a Swagger) che forniscono la possibilità di documentare le API di HATEOAS?Documentazione di un'API HATEOAS di primavera

L'interfaccia Swagger è abbastanza buona ma non ha il supporto REST di livello 3.

+0

@GhostCat Ho pensato che fosse una domanda abbastanza ridicola dopo che la mia testa riemerse dalla tana del coniglio di DI e potevo vederlo per quello che era. –

+1

Beh, posso conviverci ... E anche questa domanda vale la pena di inversione di tendenza ;-) – GhostCat

risposta

2

Dopo ulteriori indagini ho scoperto HAL-browser (https://github.com/mikekelly/hal-browser) che è abbastanza buono. Sebbene, l'API deve restituire il tipo di contenuto di HAL per questo.

Non è necessario configurare nulla sul server per questo strumento. Basta aprirlo in un browser e puntare alla tua API.

+1

HAL Browser è ora un modulo che puoi installare con coordinate maven org.springframework.data:spring-data-rest-hal- browser. – gregturn

3

Io uso spring-restdocs in combinazione con il browser HAL.

Tuttavia, non è necessario HAL per i restdoc, sebbene sia consigliato.

Restdocs genererà esempi di codice e collegherà i descrittori di campo & nel formato asciidoc. È quindi possibile collegarsi a questi asciidoc dall'interno del browser HAL.

Per vedere il risultato in azione (anche se questo è hardcoded), controllare questo: foxycart. Fai clic sui link piccoli doc accanto ai rel.