API Documentation

O que é o API Documentation?

Crie documentação da API com o Postman

Use o recurso de documentação da API do Postman para gerar uma documentação, bonita e legível por máquina, para sua API e mantê-la automaticamente atualizada.

Crie rapidamente a documentação da API personalizada

O Postman permite publicar documentação de maneira rápida e fácil. O Postman puxa automaticamente suas solicitações de amostra, cabeçalhos, trechos de código e entre outros para preencher sua página de documentação com exemplos dinâmicos e instruções legíveis por máquina, para que você possa compartilhar facilmente sua API com o resto do mundo.

Crie documentação confiável, compartilhável e fácil de seguir com o Postman

• Atualize automaticamente sua documentação
• Nunca deixe a documentação ficar para trás do serviço novamente. O Postman atualiza automaticamente sua documentação toda vez que você faz alterações na sua coleção - em tempo real.
• Compartilhe facilmente com o botão “Executar” no Postman
• Compartilhe sua coleção em segundos. Incorpore o botão “Executar no Postman” na sua página de documentação ou em qualquer outro site para permitir que qualquer pessoa importe sua coleção com um clique.
• Ganhe a adoção da sua API
• Se você usa APIs, sabe a importância da documentação para comunicar instruções de uso. A documentação do Postman é legível por máquina, então qualquer pessoa - desenvolvedores, testadores, gerentes de produto ou parceiros - pode consumir diretamente sua API por meio da instância do Postman.
• Colabore com sua equipe no Documentos
• O recurso de comentários do Postman permite que você e sua equipe compartilhem feedback por meio de comentários e revisões de código. Você pode organizar e notificar facilmente seus colegas de equipe sobre alterações ou erros, para poder apresentar a melhor documentação possível para seus usuários.

Introdução à documentação

Crie documentação dinâmica de maneira fácil, rápida e contínua com o gerador de documentação da API do Postman.

O recurso de documentação da API do Postman permite exibir a documentação privada da API ou compartilhar a documentação pública da API em uma página da Web lindamente formatada. O Postman gera e hospeda automaticamente a documentação da API baseada em navegador para suas coleções em tempo real. Cada coleção possui uma visualização de documentação pública e privada que o Postman gera a partir de dados sincronizados nos servidores.

Simplifique o desenvolvimento de API com o Postman

Mais de 8 milhões de usuários e 300 mil empresas usam o Postman, tornando o Postman a plataforma de desenvolvimento de API mais popular do mundo. Gerencie suas APIs facilmente com o único ambiente de desenvolvimento de API completo.

Requisitos do sistema:

OSX (x64) / Windows (x86 or x64) / Linux (x86 ou x64).