Mailgun Hack Day: deixando nossa documentação da API mais inteligente

Todos os meses, nossa equipe tem a oportunidade de programar no que quisermos. Uma maneira divertida de aprender algo novo, colaborar com diferentes pessoas da equipe ou apenas resolver algo que estava nos incomodando.

No hack day de janeiro, parte da nossa equipe (Anton, Jesse e eu) decidiu fazer algumas melhorias em nossa documentação da API.

Nossa API é bem documentada e possui uma boa variedade de exemplos de código para todas as principais linguagens de programação. No entanto, notamos algumas questões sobre o fluxo de trabalho.

Para testar uma solicitação de API, profissionais de desenvolvimento normalmente fariam o seguinte:

1. Copiar um exemplo de código para um editor de texto
2. Editar alguns parâmetros (por exemplo, remetente, destinatário, texto do corpo)
3. Acessar o Painel de Controle do Mailgun para copiar a chave de API
4. Voltar ao editor de código e colar a chave
5. Copiar o exemplo para a linha de comando e executá-lo

Para explorar um novo serviço ou testar um novo endpoint rapidamente, isso parece ter etapas demais.

Agora, os exemplos de código que mostramos para você são um pouco mais inteligentes. Se você tiver feito login no Mailgun, inseriremos sua chave de API e alguns padrões inteligentes para você.

Portanto, é só copiar e colar os exemplos de código na sua linha de comando, executar e tudo deve funcionar imediatamente.

Também tornamos os exemplos de código editáveis. Usando o editor Ace, clicar em qualquer exemplo de código o transformará em um pequeno editor de texto no próprio navegador, onde você poderá fazer alterações.

A documentação da API é fundamental para a experiência do usuário de um serviço de desenvolvimento. Com as mudanças acima em produção, esperamos que testar nossa API fique muito mais fácil para quem está começando a explorar nosso serviço, além de profissionais que já utilizam a plataforma e desejam testar ou solucionar problemas em diferentes endpoints da API.

Confira as melhorias na documentação de desenvolvimento do Mailgun.

Autor: The Sinch Mailgun team The Sinch Mailgun team shares news, best practices, and strategies to take your products and apps to the next level using email. Subscribe to our newsletter to get all the articles in your inbox!