Readme

O Readme é uma plataforma para publicar documentação de API: guias de integração e uma referência interativa gerada a partir da especificação da API, para que desenvolvedores consumam o serviço sem apoio do time que o construiu.

A referência aceita arquivos OpenAPI 3.0, OpenAPI 3.1 e Swagger 2.0, enviados por upload, por URL ou sincronizados a partir do GitHub ou do GitLab. Em cada página da referência, o recurso Try It permite que o leitor envie requisições reais e veja o histórico delas.

A documentação também pode viver em um repositório Git: a sincronização é bidirecional com GitHub, GitHub Enterprise Server e GitLab, e o time revisa, aprova e faz merge de branches dentro do Readme.

O Readme atende times de produto e de plataforma que expõem uma API a clientes, parceiros ou outros times internos. O plano Starter é gratuito e inclui domínio próprio, e o Pro e o Enterprise acrescentam recursos de equipe e de governança.

O Readme tem três planos: Starter gratuito (US$ 0 por mês), Pro a US$ 250 por mês, cobrado anualmente, e Enterprise sob consulta.

O Starter inclui 1 projeto, 1 administrador e domínio próprio. A documentação de equipes limita esse plano a 1 teammate.

O Pro inclui até 5 administradores, e a documentação cita US$ 20 por administrador adicional. Segundo a documentação, ele acrescenta conteúdo reutilizável, revisões, branching e HTML e CSS personalizados.

O Enterprise aparece como "Contact Us", com cobrança apenas anual. Ele acrescenta SSO, OAuth, logs de auditoria e controle de papéis, além da combinação de vários projetos.

O Ask AI completo é um complemento de US$ 150 por mês, disponível em qualquer plano.

Preços de lista publicados pelo fornecedor, consultados em outubro de 2026. Pela Nexforce Marketplace, o Readme pode ser contratado em reais, com nota fiscal brasileira.

Os principais recursos do Readme são a referência de API interativa gerada de OpenAPI, o playground Try It, a sincronização bidirecional com Git, o branching e recursos para agentes de IA, como LLMs.txt e servidor MCP.

• Referência de API: importa OpenAPI 3.0, OpenAPI 3.1 e Swagger 2.0 por upload, por URL ou por sincronização com GitHub ou GitLab.
• Try It: o leitor envia requisições reais pela página da referência e vê o histórico delas. As requisições também aparecem no Developer Dashboard.
• Sincronização com Git: bidirecional com GitHub, GitHub Enterprise Server e GitLab, com revisão, aprovação e merge de branches no Readme.
• CLI rdme: envia arquivos do repositório ao Readme em um sentido só, então edições feitas no editor do Readme não voltam ao repositório.
• Branches: substituem as antigas versões da documentação. O branching entra a partir do plano Pro.
• AI Dropdown, LLMs.txt e servidor MCP: incluídos no plano Starter, segundo a página de preço.
• Domínio próprio: disponível em todos os planos.

O Readme vale a pena para times que querem documentação de API com referência interativa e sincronização com Git; o salto de preço do Starter para o Pro e a limitação a 1 administrador no plano gratuito pesam contra.

Prós:

• O Starter é gratuito e já inclui domínio próprio, sincronização bidirecional com GitHub e GitLab, AI Dropdown, LLMs.txt e servidor MCP.
• A referência importa OpenAPI 3.0, OpenAPI 3.1 e Swagger 2.0 por upload, URL ou sincronização com repositório.
• O Try It deixa o leitor testar a API na própria página e mostra o histórico das requisições.
• Os administradores revisam, aprovam e fazem merge de branches dentro do Readme.

Contras:

• O Starter limita o projeto a 1 administrador e a 1 teammate.
• O Pro custa US$ 250 por mês, cobrado anualmente, e inclui 5 administradores; cada administrador adicional tem custo extra.
• SSO, OAuth e logs de auditoria só aparecem no Enterprise, que é sob consulta e só anual.
• O Ask AI completo é um complemento de US$ 150 por mês em qualquer plano.
• A CLI rdme envia arquivos em um sentido só, então edições feitas no editor do Readme não voltam ao repositório.

As principais alternativas ao Readme são Postman, Apidog e Fern, que cobrem a documentação de API a partir de ângulos diferentes.

• Postman: organiza requisições em coleções que a equipe compartilha e transforma em documentação, e também faz testes automatizados, mocks e monitores. A documentação é parte de uma plataforma maior de trabalho com APIs.
• Apidog: parte de um editor visual de OpenAPI, e o mesmo contrato alimenta mock, depuração, testes e documentação publicada, com versionamento e domínio próprio. Tem plano gratuito para até 4 usuários.
• Fern: aparece no comparativo publicado pelo próprio Readme como um pipeline de SDKs, em oposição ao Readme, descrito como um hub de documentação.

Se o objetivo é só publicar a referência e os guias para quem integra a API, o Readme é o produto dedicado a isso. Se a equipe quer projetar, testar e documentar no mesmo lugar, Postman e Apidog cobrem mais etapas.