Saúde
1 função do TermoLeads para saúde.
// npm install termo_core --save-exact
import * as leads from "termo_core/leads";
// ou: import { leads } from "termo_core";| Função | Rota | O que faz |
|---|---|---|
verificar_saude | GET /healthz | Confere se a API está no ar |
verificar_saude
GET/healthz Pública
Confere se a API está no ar
Rota pública, sem login. Responde status: ok e a versão do backend no ar (semver) quando o servidor está de pé; não consulta o banco nem o TermoAuth.
function verificar_saude(
opcoes_da_chamada?: OpcoesDaChamada,
): Promise<tipos.SaudeDoBackend>import { verificar_saude } from "termo_core/leads";
const resposta = await verificar_saude();Argumentos
Nome
Tipo
Retorno: Promise<tipos.SaudeDoBackend> · Rust: Result<tipos::SaudeDoBackend, ErroAoChamarServico> · veja SaudeDoBackend.
Tipos
Tipos usados pelas funções desta página. O nome é o mesmo nos dois pacotes.
SaudeDoBackend
import type { SaudeDoBackend } from "termo_core/leads";
export interface SaudeDoBackend {
/**
* Sempre `ok` quando o servidor está no ar
*/
status: string;
/**
* Versão do backend no ar (semver do Cargo.toml)
*/
versao: string;
}