Documentação da aplicação

Instalar construtor da documentação

$ cd /path/to/env/app_backend/app
$ ../bin/pip install mkdocs

Executar build da documentação

$ cd /path/to/env/app_backend/app
$ ../bin/mkdocs build

Deploy documentação

  • Aticionar git-remote remote 
$ cd /path/to/env/app_backend/app
$ git remote add github_io git@github.com:helpec/helpec.github.io.git
  • Enviar arquivos buildados
$ cd /path/to/env/app_backend/app
$ ../bin/mkdocs gh-deploy

Build documentação API

  • Exportar JSON do Postman

    Exporte sua coleção do Postman (somente suporte para Collection v2 por enquanto). Você poderia obter um arquivo JSON.

    Primeiro Passo: Selecione a coleção que você deseja exportar. Primeiro Passo: Selecione a coleção que você deseja exportar.

    Segundo Passo: Encontre o botão de importação e clique nele. Segundo Passo: Encontre o botão de importação e clique nele.

    Terceiro Passo: Exporte sua coleção como coleção v2. Terceiro Passo: Exporte sua coleção como *coleção v2*.

  • Rode postdown para gerar markdownda documentação

    bash $ postdown xxx.json xxx.md