Ver categorias
Explorar
Fiverr Pro
Português
$
USD
Vou escrever documentação de API, especificação OpenAPI Swagger, guias para desenvolvedores e docs de SDK
Documentação técnica e automação de dados para equipes de software
Sou engenheiro de software. Escrevo os documentos que as equipes de software precisam e ninguém quer escrever: especificações de requisitos, referências de API, manuais do usuário, runbooks. E automat...
Sobre este Serviço
Fique à vontade para me escrever em italiano.
A maioria da documentação de API é escrita por alguém que não consegue ler o código. Por isso ela fica desatualizada em três semanas, e por isso seus usuários ainda abrem tickets perguntando o que significam os códigos de erro.
Sou engenheiro de software. Me envie o repositório, a coleção do Postman ou o arquivo de rotas — eu mesmo leio e escrevo a documentação que realmente corresponde ao que o serviço faz.
O QUE VOCÊ RECEBE
- Cada endpoint: método, caminho, autenticação, parâmetros, request e response
- Respostas de erro reais, com o que as causa e o que fazer a respeito
- Um exemplo funcional por endpoint, em curl e na linguagem de sua preferência
- Um arquivo OpenAPI 3 válido, para que a documentação possa ser regenerada após você alterar o código
- Um site de documentação publicado no Redoc, Swagger UI ou Mintlify (Premium)
REST, GraphQL, webhooks e SDKs. Nunca preciso das suas chaves de produção.
Se sua API tiver problemas de nomenclatura ou tratamento de erros, eu aviso antes de escrever. Documentar uma API confusa só torna a confusão oficial.
Tipo de Documento:
Documentação
•
Especificações técnicas
Setor:
Software
Idioma:
Inglês
•
Italiano
Preferência de estilo de entrega
Informe o freelancer sobre suas preferências ou preocupações em relação ao uso de ferramentas de IA na conclusão e/ou entrega de seu pedido.
Meu portfólio
Perguntas frequentes
Tradução automática
O que você precisa para documentar minha API?
Qualquer uma dessas opções funciona: um repositório, uma coleção Postman, um schema GraphQL, um arquivo OpenAPI existente ou uma chave sandbox. Se você não tiver nenhum deles, uma sessão de compartilhamento de tela onde você me mostra as chamadas já é suficiente para começar.
Você publica a documentação ou só me entrega os arquivos?
Ambas as opções são possíveis. A documentação básica e de referência é entregue como Markdown mais um arquivo OpenAPI que você hospeda. A documentação completa inclui um site de documentação funcional, criado com um gerador estático, pronto para ser implantado no seu próprio domínio.
Você vai manter a documentação atualizada quando a API mudar?
Sim, como um pedido separado menor. Me envie o changelog ou o diff e eu atualizo as seções afetadas. Como você mantém os arquivos fonte, sua equipe também pode fazer a manutenção sem minha ajuda.
