dadosjusbr / api-doc

Documentação da api do dadosjusbr
https://dadosjusbr.github.io/api-doc/
MIT License
0 stars 0 forks source link

Documentação da API do dadosjusbr

Como documentamos a api do DadosJusBr?

Utilizamos o insomnia-rest para testar e documentar endpoints, após escrever as documentações geramos o html da doc que será colocada em produção usando a lib insomnia-documenter

Gerando a documentação

para gerar a documentação é necessário ter o nodejs e o yarn instalados, ciente disso:

Após a execução do comando ele irá modificar o arquivo insomnia.json da raiz e da pasta assets, esses arqivos são usados pelo script do insomnia-documenter para gerar o html da doc