Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

    • Revisitar nomenclaturas e rotas no API-Hub para não usar "/smartview/" e sim "/business-objects" (deixar agnóstico no API-Hub, sem vínculo) 
    • Implementar segurança (header Authorization) no API-Hub para "/business-objects/" para dois níveis de autenticação: 1. via credenciais padrão do API-Hub (assim como já acontece nas demais APIs do Bioenergia) e, caso dê 401 (ou token expirado, enfim), seguir para o modelo 2. via T-Provider & Keycloak (únido modelo que seria chamado pelo Smart View)
    • Trocar "isEnableSmartView" para "isBusinessObject" (no modelo de dados) - revisar colunas (banco de dados) para não usar palavra "smart_view", por exemplo, "enable_smart_view"
    • Incrementar APIs de Objetos de Negócio (ON) para que, além do modelo de Entidades (Entity), também se permita usar o conceito de ON para o modelo Consulta (Query);
    • Revisitar abordagem de "v1" e/ou "versão de API de release" para permitir uma recuperação mais dinâmica e inteligente das APIs e suas versões;
    • Concatenar, no nome do objeto de negócio, a versão, por exemplo "Fazenda (v1)", "Fazenda (v2)" ...
    • Quando for utilizar/implementar modelo Query, avaliar uso de nova tabela "query_filters" ou evoluir "query_fields" - objetivo: melhor controlar/catalogar os possíveis filters de APIs GET do tipo Query, para serem utilizadas como filters ou parameters (objetos de negócio)
    • Implementar POST na camada de abstração para chamar GET (da API Padrão, seja Entity ou Query, e depois EntryPoint), para properties =[], filters = [] e parametros = [] ou com filtros utilizados no GET da API Padrão (por exemplo, ?codigoTurma=123)

03. SOLUÇÃO

  • Criar listagem, schemas e recuperação de dados para Objetos de Negócio (ADR010001)
    • Solução: Implementada camada de Business Objects que expõe listagem (catálogo), endpoints de schema e endpoints de dados. Suporta Entity e Query, com contrato compatível com Smart View.

...

  • Trocar rotas

...

  • de "/smartview/" por "/business-objects"
    • Solução: URLs padronizadas para /business-objects/v1 (base), com caminhos de schema e data usando esse prefixo.
  • Implementar segurança (header Authorization) em dois níveis: 1) credenciais API-Hub; 2) fallback T-Provider & Keycloak
    • Solução: Fluxo de autenticação em duas camadas implementado — primeiro tenta credenciais do API-Hub; em caso de 401/expiração faz fallback para T-Provider/Keycloak.
  • Trocar isEnableSmartView para isBusinessObject e revisar colunas do BD
    • Solução: Mudanças a nível de dados (migrations/colunas antigas contendo "smart_view").
  • Permitir ON também para modelo Query (além de Entity)
    • Solução: Query-based Business Objects adicionados à listagem; geram schema (properties/parameters) e endpoint de dados. Parâmetros da query são extraídos automaticamente (tokens ::campo) e expostos como parameters.
  • Revisitar versão de API e concatenar versão no nome do objeto (ex.: "Fazenda (v1)")
    • Solução: displayName do Business Object concatena nome com versão do endpoint (ex.: Nome (v1)); as URLs usam a versão no caminho base (/v1).
  • Ao usar Query: avaliar query_filters ou evoluir query_fields para catalogar filters/parameters
    • Solução: mantém-se hoje o uso de query_fields (muitos migrations já populam essa estrutura). A extração de filtros é feita a partir da própria query (padrão ::field) e convertida em parâmetros.
  • Implementar POST na camada de abstração para chamar GET (body: properties=[], filters=[], parameters=[])
    • Solução: Implementado fluxo que retorna os dados, mescla parâmetros do body com query string da requisição, e usa properties para filtrar campos que serão retornados para o response. Assim, um POST pode acionar o GET subjacente (Entity ou Query) com parâmetros vindos do body.
    • Observação: suporte a ENTRYPOINT e a estrutura de filters da requisição serão feitas futuramente.

Observações finais

  • Filtragem por properties atua em campos de primeiro nível; estruturas aninhadas podem exigir lógica adicional se for necessário filtrar internamente.
  • Parâmetros expostos ao cliente vêm com sufixo Param (ex.: campoParam) e esse sufixo é removido ao montar os parâmetros enviados para a API subjacente.
  • Data/time com timezone teve tratamento específico.

04. DEMAIS INFORMAÇÕES

Não se aplica.

...