Spring REST Docs e ferramentas para documentação de APIs. Alguém já usou? Como documentam suas APIs?
24/04/2017 17:55
0
Saiu agora a pouco no blog do Spring que foi liberada a versão 1.2.0 do projeto Spring REST Docs. Não conhecia o projeto então resolvi pesquisar um pouco a respeito no seu site oficial.

Alguém aqui já usou este projeto? Vi que ele inclusive se integra com o Asciidoctor, o que é bem interessante, entretanto aqui na itexto já estamos usando há um bom tempo o Swagger com sucesso.

O que vocês costumam usar para documentar suas APIs?
Tags: spring REST Docs, REST, documentação, swagger


1
Swagger parece bom, usamos com sucesso em um projeto em que eu trabalho. E um negócio que eu acho bem legal do Swagger é que há uma integração entre Compojure e Swagger via compojure-api, pra quem gosta de Clojure, como eu, é um prato cheio. :-) Noutro projeto era usado RAML mas eu achava o arquivo YAML muito gigantesco, difícil de dar manutenção. A grande vantagem que vi no compojure-api é justamente o fato do artefato do Swagger ser extraído da declaração de uma API em formato compojure. Ou seja, a documentação lado-a-lado da primeira camada de código da API. Acho que Swagger puro sofre do mesmo problema que tive com RAML...


1
Eu utilizo o SpringFox!

http://springfox.github.io/springfox/
24/04/2017 23:30


0
Muito interessante este SpringFox!


0
Eu utilizo o springfox também, mas estou vendo para começar a migrar para o spring-rest-docs, porque com o swagger eu preciso ficar alterado o arquivo pra gerar a documentação no meu Zuul :(
26/04/2017 09:23


0
Estou usando o SpringFox com annotations.  Por enquanto está me atendendo mas tive vi umas limitações relacionadas a documentar objetos do tipo List<MeuObjeto>.
27/04/2017 13:06



Ainda não faz parte da comunidade???

Para se registrar, clique aqui.


Aprenda Groovy e Grails, Spring e mais com a Formação itexto!

Livro de Spring


/dev/All

Os melhores blogs de TI
em um único lugar!

 
Spring Brasil é mantido por itexto Consultoria.
Em caso de problemas contacte Henrique Lobo Weissmann (Kico) por e-mail: kico@itexto.com.br
Todo o conteúdo presente neste site adota o Creative Commons como licença padrão.