Ver categorias
Português
$
USD
Conecte-se à sua IA
Vou escrever a documentação OpenAPI Swagger e uma coleção Postman para a sua API
Redator Técnico e Engenheiro de Software
Sou redator técnico e engenheiro de software com quase 2 anos de experiência profissional. Escrevo artigos claros, tutoriais, documentação de APIs e de desenvolvedor, e posts de blog que explicam tópi...
Sobre este Serviço
Sua API é difícil de entender para outros desenvolvedores? Sou engenheiro backend e leio seu código ou a lista de endpoints para transformá-los em uma documentação clara e precisa que as pessoas realmente usem.
O que você recebe:
Uma especificação OpenAPI 3 (Swagger) com endpoints, parâmetros, exemplos de requisição e resposta e respostas de erro.
Uma coleção Postman pronta para importar, para que sua equipe e usuários possam testar a API em minutos.
Descrições em inglês simples, fáceis de ler.
Revisões até a documentação bater exatamente com o comportamento da sua API.
Funciona com APIs REST em qualquer linguagem. Eu me sinto em casa com Go, Java e back-ends TypeScript.
Como funciona: me envie sua lista de endpoints, código ou uma especificação existente. Vou perguntar sobre qualquer coisa pouco clara e depois entrego os arquivos. Vou conferindo a documentação com seus exemplos antes da entrega.
Não tem certeza de qual pacote serve? Me mande uma mensagem antes de pedir com o número de endpoints que eu sugiro um.
Tipo de Documento:
Documentação
•
Especificações técnicas
Setor:
Software
Idioma:
Inglês
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.
Perguntas frequentes
Tradução automática
O que você precisa de mim?
Sua lista de endpoints, código-fonte ou uma especificação existente, mais alguns exemplos de requisições e respostas, se você tiver.
Você pode documentar uma API que ainda não tem documentação?
Sim. Me mande o código ou a lista de endpoints e eu escrevo a especificação do zero. Posso fazer algumas perguntas sobre o comportamento que não fica claro no código.
Tenho mais de 30 endpoints. Você ainda consegue ajudar?
Sim. Me mande o tamanho da sua API e eu envio uma oferta personalizada.
