[Gov.Doc] Alterações necessárias para descontinuar o uso do contexto
Data de elaboração | 04/11/2022 |
---|---|
Responsável pelo estudo |
Nara Carolina Galvão Feitosa Raissa de Sousa Stodulski Vinicius da Rosa Pereira |
Equipe do estudo | Tambakiss |
Alvo | Gov.Doc |
Origem |
Melhorar implementação já feita pois o contexto é para ser usado somente na API |
Objetivo | Se o contexto e regras de negócios centralizarem no Gov.Doc API, irá parar de gerar trabalho dobrado. Hoje, se alterar algo no Gov.Doc, precisa alterar no Gov.Doc API também. |
Documentação correlata (opcional) | |
Observações |
1. Introdução
Para cessar implementações duplicadas no Gov.Doc e Gov.Doc API, se deixarmos o contexto e toda a regra de negócio na API, podemos implementar novas funcionalidades ou corrigir as já existentes somente na API.
2. Alterações necessárias
2.1 BlocosDeAssinaturas
- Index
- [
API]API] Criar endpointparaBlocosDeAssinaturas/Cpf/{cpf}buscar-blocosnomededoassinaturasmétodopelo CPFBuscarPorCpf - [
Sistema]Sistema] Chamar novo endpoint BuscarPorCpf
- [
- Recebidos
- [
API]API] Criar endpointparaBlocosDeAssinaturas/Recebidos/{cpf}buscar-blocosnomededoassinaturasmétodopeloRecebidos- Filtrar: CPF, justificativa de recusa nula e status diferente de assinado
- [
Sistema]Sistema] Chamar novo endpoint Recebidos
- [
- Criar
- [
API]API] Criar endpointparaDocumentos/Cpf/{cpf}buscar- nome do métododocumentosBuscarPorCpfpelo- Parâmetros
- IdBlocoDeAssinatura, opcional
- PodeAdicionarNoBloco, opcional
- Filtrar: CPF, não excluído.
- Se PodeAdicionarNoBloco for true, filtrar os sem bloco
e não excluídoParâmetro opcional: idBlocoDeAssinaturaFiltro vai ficar: sem blocooucom oonde IdBlocoDeAssinatura =idBlocoDeAssinaturaIdBlocoDeAssinatura (se for informado por parâmetro)
- Se PodeAdicionarNoBloco for true, filtrar os sem bloco
- [
Sistema]Sistema] Chamar novo endpointno Criar (Get)
BuscarPorCpf
- Parâmetros
- [
- Editar
- [
Sistema]Sistema] Chamar endpoint existenteBlocoDeAssinatura/BlocosDeAssinaturas/{id}(Get) no Editar (Get)
- [
- DetalhesBlocoRecebido
- [
Sistema]Sistema] Chamar endpoint existenteBlocoDeAssinatura/BlocosDeAssinaturas/{id}(Get)
- [
- Detalhes
- [
Sistema]Sistema] Chamar endpoint existenteBlocoDeAssinatura/BlocosDeAssinaturas/{id}(Get)
- [
- Recusar
- [
Sistema]Sistema] Chamar endpoint existenteBlocoDeAssinatura/BlocosDeAssinaturas/{id}(Get) - [
API]API] Criar endpoint BlocosDeAssinaturas/Recusar - nome do método Recusar - [
Sistema]Sistema] Chamar novo endpoint Recusar
- [
2.2 Documentos
- Index
- [
Sistema]Sistema] Chamar novosendpointsendpoints: BuscarPorId, Buscar e BuscarPorCpf - [
API]API] Criar endpoint Modelos/{id} - nome do método BuscarPorId - [
API]API] Criar endpoint Modelos - nome do método Buscar - [
API]API]CriarAlterar endpointparacriadoconsultarDocumentos/Cpf/{cpf} - nome do método BuscarPorCpf- Parâmetros novos:
- IncluirDocumentosCompartilhados, opcional
- IncluirArquivados, opcional
- Filtrar:
- Se IncluirDocumentosCompartilhados for true, trazer documentos compartilhados com o cpf
- Se
criadosIncluirArquivadospeloforcpffalse,quefiltrar os documentos nãoosforamarquivados.
ouexcluídosnem
arquivados - Parâmetros novos:
- [
- Autenticidade
- [
API]API] Criar endpointparaDocumentos/Numeracao/{numeracao}consultar-documentosnomecomdoaquelamétodonumeraçãoBuscarPorNumeracao - [
Sistema]Sistema] Chamar novo endpoint BuscarPorNumeracao
- [
- Arquivados
- [
API]API] Criar endpointparaDocumentos/Arquivados/{cpf}consultar-documentosnomearquivadosdo(método Arquivados- Filtrar: não excluídos, daquele cpf e
arquivados)arquivados
- Filtrar: não excluídos, daquele cpf e
- [
Sistema]Sistema] Chamar novo endpoint Arquivados
- [
- Criar
- [
API]API] Chamar novosendpointsendpoints:criadosBuscarPorIdConsultarBuscartodos os modelosConsultar modelo pelo id
- [
- [
Sistema]Sistema] Chamar endpoint existentepara buscar documento pelo IdDocumentos/{id}
- [
API]API] Criar endpoint Documentos/{id}/Restringir - nome do método Restringir - [
Sistema]Sistema] Chamar novo endpoint Restringir
- [
API]API] Criar endpoint Documentos/{id}/RemoverRestrição - nome do método RemoverRestricao - [
Sistema]Sistema] Chamar novo endpoint RemoverRestricao
- [
API]API] Criar endpoint Documentos/{id} (DELETE) - nome do método Excluir - [
Sistema]Sistema] Chamar novo endpoint Excluir
- [
Sistema]Sistema] Chamar endpoint existentepara buscar documento pelo IdDocumentos/{id}
- [
Sistema]Sistema] Chamar endpoint existentepara buscar documento pelo IdDocumentos/{id} - [
API]API] Criar endpointAlterarCodigoVerificadorDocumentos/{id}/AtualizarCodigoVerificador - nome do método AtualizarCodigoVerificador - [
Sistema]Sistema] Chamar novo endpoint AtualizarCodigoVerificador
- [
Sistema]Sistema] Chamar endpoint existentepara buscar documento pelo IdDocumentos/{id}
- [
Sistema]Sistema] Chamar endpoint existentepara buscar documento pelo IdDocumentos/{id} - [
Sistema]Sistema] Chamar novo endpointAlterarCodigoVerificadorAtualizarCodigoVerificador
- [
API]API] Criar endpoint Documentos/{id}/Desarquivar - nome do método Desarquivar - [
Sistema]Sistema] Chamar novo endpoint Desarquivar
- [Sistema] Chamar endpoint existente Documentos/{id}
asd[API] Criar endpoint Documentos/{id}/Historico (POST) - nome do método RegistrarNoHistorico- [Sistema] Chamar novo endpoint RegistrarNoHistorico
Conforme
2.3 DocumentosEditor
- Todas as actions
- [API] Criar endpoint Editor/FontsFamilies - nome do método Fontes
- [API] Criar endpoint Editor/FontsSizes - nome do método TamanhosFontes
- [API] Criar endpoint Editor/Tools - nome do método Ferramentas
- [Sistema] Chamar novos endpoints: Fontes, TamanhosFontes e Ferramentas
2.4 Erros
ConforNão possui acesso ao contexto.
2.5 Home
- Painel
- [API] Criar controller/endpoint Painel (GET) - nome do método Buscar
- [Sistema] Chamar novo endpoint Buscar
2.6 Imagens
Não possui acesso ao contexto.
2.7 Modelos
- Index
- [API] Alterar endpoint criado Modelos - nome do método Buscar
- Parâmetros novos:
- IncluirNumeracaoDoUltimoDocumento, opcional
- Filtrar:
- Se IncluirNumeracaoDoUltimoDocumento for true, pegar numeração do último documento do modelo
- Se IncluirNumeracaoDoUltimoDocumento for true, pegar numeração do último documento do modelo
- Parâmetros novos:
- [Sistema] Chamar novo endpoint: Buscar
- [API] Alterar endpoint criado Modelos - nome do método Buscar
- Criar
- [API] Criar endpoint Modelos (POST) - nome do método Criar
- [Sistema] Chamar novo endpoint Criar
- Editar
- [API] Criar endpoint Modelos/{id} (PUT) - nome do método Editar
- [Sistema] Chamar novo endpoint Editar
- Ativar
- [API] Criar endpoint Modelos/{id}/Ativar - nome do método Ativar
- [Sistema] Chamar novo endpoint Ativar
- Desativar
- [API] Criar endpoint Modelos/{id}/Ativar - nome do método Desativar
- [Sistema] Chamar novo endpoint Desativar
2.8 PatchNotes
Não possui acesso ao contexto.
2.9 Sistemas
- Index
- [API] Criar controller/endpoint Sistemas (GET) - nome do método Buscar
- [Sistema] Chamar novo endpoint Buscar
- Criar
- [API] Criar controller/endpoint Sistemas (POST) - nome do método Criar
- [Sistema] Chamar novo endpoint Criar
- Detalhes
- [API] Criar endpoint Sistemas/{id} (GET) - nome do método BuscarPorId
- [Sistema] Chamar novo endpoint BuscarPorId
2.10 UsuariosExterno
- SolicitarAssinatura
- [API] Criar endpoint Documentos/{id}/SolicitarAssinatura - nome do método SolicitarAssinatura
- [Sistema] Chamar novo endpoint SolicitarAssinatura
3.Conclusão
Concluímos que essaessas alteraçãões necessárias para descontinuar o deveuso atenderdo acontexto. necessidade.O Háprojeto ainda é passível de outras soluçõesmelhorias casocomo essa nãpadrão atenda mas que acreditamos não será necessário, pois essa alteração é simples e de baixaAPI complexidade.Restful.