Skip to content

Commit 8b8cd4f

Browse files
docs(serverest): implementar nova documentação com swagger
closes #165 closes #235
1 parent c18eec5 commit 8b8cd4f

File tree

10 files changed

+1335
-6673
lines changed

10 files changed

+1335
-6673
lines changed

.github/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,11 @@ Para aprofundar sobre como é feita a publicação do _ServeRest_, leia o texto
173173

174174
## Documentação
175175

176-
A documentação, disponibilizada nas URLs <https://serverest.dev> e <http://localhost:3000>, é editada no arquivo `serverest.apib` e gerada a partir do [aglio](https://www.npmjs.com/package/aglio).
176+
A documentação, disponibilizada nas URLs <https://serverest.dev> e <http://localhost:3000>, é editada no arquivo [swagger.json](../docs/swagger.json).
177177

178178
Para atualizar:
179-
1. Acesse o arquivo `serverest.apib` que está dentro de _docs_ e o edite de acordo com sua necessidade.
180-
1. Execute o comando `npm run generate-doc:AMBIENTE` para gerar o HTML final.
179+
1. Acesse o arquivo [swagger.json](../docs/swagger.json) e o edite de acordo com sua necessidade.
180+
1. Execute o comando `npm run dev` para acompanhar o status da documentação alterada na URL <http://localhost:3000>.
181181

182182
## Reconhecimento de contribuição
183183

docs/agilizei.html

Lines changed: 0 additions & 607 deletions
This file was deleted.

docs/localhost.html

Lines changed: 0 additions & 618 deletions
This file was deleted.

0 commit comments

Comments
 (0)