Portal de API da instalação

A plataforma pode publicar uma referência interativa das APIs (portal Scalar) em duas formas:

Portal	Endereço	Painel de testes
Referência pública	Referência interativa	Só mostra o formato das requisições; não chama nenhuma instalação.
Portal da instalação	https://docs.<domínio>	Chama a API da própria instalação em api.<domínio>, com a autenticação normal das APIs.

Ativar o portal da instalação

O portal vem desligado. Para ativá-lo, ligue a opção no alvo de deploy, no finnest.toml:

# Alvo nomeado (perfil):
[profile.banco-prod]
# …demais campos do alvo…
docs_enabled = true

# Formato antigo, com um único alvo:
[deployment.docs]
enabled = true

Depois rode o deploy:

CLOUD=aws ENVIRONMENT=sandbox  # ou: azure, prod
finnest deploy --cloud="$CLOUD" --environment="$ENVIRONMENT" --preview
finnest deploy --cloud="$CLOUD" --environment="$ENVIRONMENT" --apply --yes

Com o portal ligado, o resultado do deploy mostra o endereço em Endpoints → docs.

Certificado TLS na primeira ativação

docs.<domínio> é um host novo. O certificado TLS é emitido pelo Let's Encrypt, via cert-manager, depois que a rota é aplicada, e isso leva alguns minutos. Se o navegador mostrar um aviso de certificado (por exemplo, NET::ERR_CERT_COMMON_NAME_INVALID) logo após o deploy, espere alguns minutos e recarregue a página.

Para confirmar que o portal está no ar:

CLOUD=aws ENVIRONMENT=sandbox  # ou: azure, prod
finnest doctor --cloud="$CLOUD" --environment="$ENVIRONMENT"

As verificações do portal no doctor confirmam que docs.<domínio> responde com certificado válido e com as especificações esperadas.

Verificação

• O resultado de finnest deploy mostra https://docs.<domínio> em Endpoints → docs.
• Depois da emissão do certificado, docs.<domínio> abre a referência sem aviso de TLS.
• No painel de testes, uma chamada a um endpoint documentado chega a api.<domínio> e devolve uma resposta real da API.
• finnest doctor mostra as verificações do portal sem falhas.