Speakeasy

Automatize trechos de uso de SDK no playground de API

Trechos de código gerados automaticamente a partir dos SDKs do Speakeasy podem ser integrados diretamente à documentação de referência de API do Mintlify. Esses trechos de uso de SDK são exibidos no playground interativo de sites de documentação com Mintlify.

Pré-requisitos

Para integrar o Mintlify ao Speakeasy, você precisará do seguinte:

• Um repositório de documentação do Mintlify.
  • Um SDK gerado pelo Speakeasy com uma URL de amostra de código automatizada configurada.

Configurando a integração

Para integrar o Speakeasy ao Mintlify, você precisa obter a URL pública da especificação combinada da API no registro e atualizar o arquivo de configuração docs.json.

Obtenha a URL pública da especificação combinada da API no registro

Acesse o seu Speakeasy Dashboard e abra a guia API Registry. Abra a entrada *-with-code-samples da API.

Se a entrada não estiver marcada como Combined Spec, verifique se a API tem uma URL automática de exemplos de código configurada.

Na página da entrada do registro, copie a URL pública fornecida.

Atualize seu arquivo de configuração docs.json

Adicione a URL da especificação combinada a uma seção Anchors ou Tabs no seu arquivo docs.json.

Adicione a URL da especificação combinada a um anchor atualizando o campo anchor no seu arquivo docs.json da seguinte forma:

docs.json

{
  "anchors": [
    {
      "name": "API Reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}

Adicione a URL da especificação combinada a uma tab atualizando o campo tab no arquivo docs.json da seguinte forma:

docs.json

{
  "tabs": [
    {
      "name": "API Reference",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}

Trechos de código gerados pelo Speakeasy agora podem ser exibidos na sua documentação de API e usados no playground.