Documentação da minha API no Postman
Pessoal, eu já postei aqui antes a respeito da minha API de emissão de NFe/NFCe.
Ela já foi desenvolvida e está sendo testada em "produção" em alguns clientes meus.
É estranho você falar teste em produção, mas para ser mais especifico fizemos testes internos com a equipe fazendo várias emissões e etc, mas num ambiente real, com dados reais é totalmente diferente. Tendo em vista isto, eu colquei para alguns dos meus clientes fazerem a emissão de notas fiscais a partir desta API. Está funcionando, isto é bom.
Algo que não tinha postado antes era a documentação da API por que não estava pronta e hoje finalizamos ela ou deixamos o mais pronto possivel para poder divulgar, por que até então estava apenas disponivel para uso interno.
Nós não usamos gitbook ou algum outro site para divulgar a documentação da API, utilizamos nossa conta do Postman onde publicamos as collections, exemplos e colocamos algumas observações.
No inicio é explicado como deve ser preenchido as requisições, os tipos de dados, tipos de retornos, a estrutura como um todo e etc. Nos exemplos utilizamos o padrão de colocar variáveis e não dados reais, mas na frente do campo estamos usando comentários para explicar o que é cada campo.
Eu creio que ficou bom, mas gostaria dos feedbacks da comunidade a respeito dela.
Ficou realmente bom? O que poderia mudar?
Link da Documentação:
https://documenter.getpostman.com/view/39422436/2sAYkDMLGg
Postagens Anteriores:
https://www.tabnews.com.br/valterpatrick/testar-api-de-emissao-de-notas-nfe-modelo-55-e-nfce-modelo-65-cupom-eletronico
https://www.tabnews.com.br/valterpatrick/testar-api-de-emissao-de-notas-fiscais-de-produtos-nfe-modelo-55-e-nfce-modelo-65-cupom-eletronico