Framework_Consumo_API_SP2_MI_Framework_API_Documentacao_de_sistema

Prévia do material em texto

Framework 
Front-End com 
Consumo de API 
2 Programador Full Stack | SENAI 
 
 
 
Documento de visão do negócio 
 
Elaboração: Lucas Zavistanovicz 
Finalidade 
Este documento tem como objetivo fornecer uma visão abrangente do projeto de desenvolvimento de um Framework Front-End com 
Consumo de API, delineando sua finalidade, escopo, características do produto, posição no mercado, equipe envolvida, restrições, requisitos, 
modelagem de caso de uso, definições importantes e referências. 
Escopo 
O escopo deste projeto abrange o desenvolvimento de um Framework Front-End com Consumo de API, fornecendo uma estrutura modular 
para a criação de interfaces de usuário dinâmicas e interativas, integradas de forma eficiente com serviços externos por meio do consumo de 
APIs. 
Visão geral 
Este projeto visa facilitar o desenvolvimento de aplicações web modernas, permitindo aos desenvolvedores criar interfaces de usuário 
intuitivas e responsivas, que se integram de maneira transparente com serviços externos por meio de APIs. O Framework Front-End com 
Consumo de API oferecerá uma arquitetura flexível e extensível, suportando diversos frameworks JavaScript e proporcionando uma 
experiência de desenvolvimento eficiente. 
3 Programador Full Stack | SENAI 
 
 
 
Visão geral do produto 
O produto resultante deste projeto será um conjunto de bibliotecas, componentes e ferramentas que permitirão aos desenvolvedores 
construir aplicações web robustas e escaláveis. Ele incluirá funcionalidades para consumo de API, gerenciamento de estado, componentes 
reutilizáveis e documentação abrangente. 
Posicionamento no mercado 
O Framework Front-End com Consumo de API ocupará uma posição única no mercado, oferecendo uma solução completa para o 
desenvolvimento de aplicações web que requerem integração com serviços externos. Ele se destacará pela sua arquitetura modular, suporte 
a diversos frameworks JavaScript e foco na simplicidade e eficiência do desenvolvimento. 
Descrição da equipe desenvolvedora e dos clientes 
A equipe de desenvolvimento será composta por engenheiros de software com experiência em desenvolvimento web e conhecimento em 
frameworks JavaScript. Os clientes-alvo incluem empresas de tecnologia, startups e desenvolvedores independentes que buscam uma solução 
robusta e flexível para o desenvolvimento de suas aplicações web. 
Alternativas e concorrências 
As alternativas existentes incluem outros frameworks front-end, como React, Angular e Vue.js, que oferecem funcionalidades semelhantes, 
mas podem não fornecer o mesmo nível de integração com APIs externas. A concorrência direta inclui outros frameworks específicos para 
consumo de API, bem como soluções customizadas desenvolvidas internamente pelas empresas. 
 
 
 
4 Programador Full Stack | SENAI 
 
 
 
 
Restrições 
O projeto deve ser desenvolvido dentro de um prazo específico e com recursos limitados. 
O framework deve ser compatível com as principais versões dos navegadores web. 
As funcionalidades de consumo de API devem ser seguras e eficientes, garantindo a proteção dos dados do usuário. 
Requisitos do produto 
 Suporte a consumo de API RESTful e GraphQL. 
 Gerenciamento de estado global da aplicação. 
 Biblioteca de componentes reutilizáveis. 
 Documentação completa e exemplos de uso. 
 Compatibilidade com os principais frameworks JavaScript. 
Modelagem de caso de uso 
A modelagem de caso de uso incluirá cenários de uso típicos do framework, como autenticação de usuário, exibição de dados de API em 
uma interface de usuário e atualização dinâmica de componentes. 
 
 
 
 
 
5 Programador Full Stack | SENAI 
 
 
 
Atores: 
Desenvolvedor: O usuário que utiliza o framework para desenvolver aplicações front-end. 
API Externa: Representa serviços externos aos quais o framework se conecta para consumir dados. 
 
Casos de Uso: 
Autenticar Usuário: O desenvolvedor pode autenticar usuários em sua aplicação por meio do framework. 
Consumir API Externa: O desenvolvedor pode integrar sua aplicação com APIs externas utilizando o framework. 
Renderizar Componentes: O desenvolvedor pode usar os componentes do framework para renderizar a interface do usuário. 
Gerenciar Estado da Aplicação: O desenvolvedor pode utilizar as funcionalidades do framework para gerenciar o estado da aplicação. 
 
Navegar Catálogo de Jogos: 
 
Navegas catálogo de jogos 
 Cenário: O Cliente visualiza a lista de jogos disponíveis na loja. 
Buscar Jogos: 
 Cenário: O Cliente pesquisa por jogos específicos na loja. 
Visualizar Detalhes do Jogo: 
 Cenário: O Cliente acessa informações detalhadas de um jogo específico, incluindo descrição, preço e avaliações. 
Adicionar ao Carrinho: 
 Cenário: O Cliente seleciona um ou mais jogos para adicionar ao carrinho de compras. 
Gerenciar Carrinho: 
 Cenário: O Cliente visualiza, edita ou remove itens do carrinho de compras. 
Realizar Compra: 
 Cenário: O Cliente conclui a compra dos jogos adicionados ao carrinho, fornecendo informações de pagamento e endereço de entrega. 
Gerenciar Estoque: 
 Cenário: O Administrador adiciona, edita ou remove jogos do catálogo da loja. 
6 Programador Full Stack | SENAI 
 
 
Gerenciar Pedidos: 
 Cenário: O Administrador visualiza, processa e atualiza o status dos pedidos dos clientes. 
Gerar Relatórios de Vendas: 
 Cenário: O Administrador gera relatórios para acompanhar as vendas e o desempenho da loja. 
 
 
Comunicações: 
As setas indicam a interação do ator com cada caso de uso. 
Definição, acrônimos e abreviações 
7 Programador Full Stack | SENAI 
 
 
API: Application Programming Interface 
UI: User Interface 
 
Referências 
FERNANDES, D. B. Metodologia dinâmica para o desenvolvimento de sistemas versáteis. São Paulo: Érica, 1999 
DEITEL. Harvey M.; DEITEL. Paul J. Java, como programar. Tradução Carlos Arthur Lang Lisbôa, 4. ed. – Porto Alegre: Bookman, 2003 
PFLEEGER, Shari Lawrence. Engenharia de software, teoria e prática. 2. ed. São Paulo: Pearson, 2004.