Exemplos

Exemplos e receitas

Receitas por intenção: escolha o que quer fazer e veja a API pública, a versão mínima, o código e o limite principal.

  • Cadastrar e listar (Dados, desde 0.7.4): Quero um cadastro com lista, busca e formulário. APIs: defineModel, fields, CoreCollection.
  • Campo calculado (Dados, desde 0.3.41): Quero um total calculado que ninguém consiga adulterar. APIs: central.domain.json, computed.
  • Modelar uma esteira (Processo, desde 0.7.4): Quero etapas com transições validadas pelo backend. APIs: central.process.json, CorePipeline.
  • Limite concorrente (Processo, desde 0.7.4): Quero que a soma das parcelas nunca passe do contratado, mesmo com acessos simultâneos. APIs: atomicInvariants, relatedSumLteParentField.
  • Registrar rota privada (Integração, desde 0.7.4): Quero um endpoint próprio com permissão. APIs: defineRoutes, GenericError.
  • Executar ação pela UI (Experiência, desde 0.7.4): Quero um botão que chama o backend e mostra o resultado. APIs: useOonApi.
  • Mestre-detalhe com abas (Experiência, desde 0.7.4): Quero editar um registro e seus filhos em uma modal. APIs: detailModal, relatedGrid, rowActions.
  • Dashboard de indicadores (Experiência, desde 0.7.4): Quero contagens e somas sem escrever agregações. APIs: CoreDashboard.
  • Integrar sistema externo (Integração, desde 0.7.4): Quero consultar uma API externa com segurança. APIs: defineRoutes, fetch, GenericError.
  • Armazenar credenciais (Segurança, desde 0.7.6): Quero guardar a chave de uma integração cifrada. APIs: capabilities.secrets.
  • Gerar PDF (Integração, desde 0.6.0): Quero transformar HTML em PDF para download. APIs: capabilities.pdf.render, useOonApi.
  • Enviar e-mail (Integração, desde 0.6.0): Quero enviar um e-mail transacional idempotente. APIs: capabilities.transactionalEmail, CoreTransactionalEmail.
  • Guardar arquivos (Dados, desde 0.7.34): Quero anexos que funcionem com várias réplicas. APIs: files.forRequest.
  • Gerenciar usuários e convites (Segurança, desde 0.7.32): Quero que um gestor convide pessoas sem ser admin. APIs: users.read, users.invite, CoreUsersAccess.
  • Medir e limitar uso (Operação, desde 0.7.34): Quero cobrar por consumo e bloquear no limite do plano. APIs: usageMetrics, usage.record, usage.assertAvailable.
  • Diagnosticar publicação (Operação, desde 0.7.4): Quero saber se meu App publicado está saudável. APIs: /health/ready, /health/version, GenericError.
  • Atualizar o Core (Operação, desde 0.7.4): Quero adotar a versão mais recente com segurança. APIs: create-central-oon docs sync, doctor.