Gerenciando documentação ao vivo
Habilitando a documentação ao vivo
Para compartilhar a documentação da sua API com pessoas que não fazem parte da sua equipe, você precisa habilitar o recurso de Documentação ao vivo.
Até que seja habilitada, ela só pode ser visualizada como uma pré-visualização para usuários que tenham acesso à definição da API.
- Alterne o botão Ativado de Desativado para Ativado e insira uma URL.
Agora sua Documentação ao vivo está disponível. Você pode clicar em Abrir para abri-lo em uma nova guia.
Desabilitando a documentação ao vivo
Desative sua documentação e selecione se deseja manter seu subdomínio.
- Se você quiser liberar o subdomínio da documentação, desmarque a caixa de seleção Manter subdomínio da documentação da API ao vivo. Por padrão, o API Designer salva o subdomínio que você definiu ao habilitar a Documentação ao vivo. Isso permite que você mantenha a mesma URL se a habilitar novamente mais tarde. Se quiser usar este subdomínio para uma API diferente, você primeiro precisará liberá-lo.
Sua Documentação ao vivo está desativada. Se você reteve o subdomínio, pode habilitá-lo novamente a qualquer momento. Caso contrário, o subdomínio poderá ser usado por outra API e você precisará inserir um subdomínio se quiser habilitar esta documentação novamente.