https://github.com/pedroka-dev/playmove-fornecedores-api
https://github.com/pedroka-dev/playmove-fornecedores-api
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pedroka-dev/playmove-fornecedores-api
- Owner: pedroka-dev
- License: mit
- Created: 2025-02-18T19:36:40.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-02-21T15:58:30.000Z (11 months ago)
- Last Synced: 2025-02-21T16:28:11.535Z (11 months ago)
- Language: C#
- Size: 7.48 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introdução
Esse proje C# ASP.NET tem o objetivo de demonstrar a conexão entre API e um protótipo de jogo Unity, utilizando como exemplo uma classe "Fornecedor" com os atributos "email" e "nome"
Gerenciamento de banco é realizado automaticamente utilizando Entity Framework 6, com um banco SQLite.
Na API, foi desenvolvido chamadas GET all, GET by id, POST, PUT, DELETE. As chamadas estão propriamente documentas no Swagger da aplicação.
O protótipo de jogo foi desenvolvido no Unity versão 2022.2.20f1 e consome os dados da API através de chamadas GET all. Ao receber os dados, é instanciado novos personagens para cada "Fornecedor".
# Requisitos
1. Configuração Inicial:
- Crie um projeto de Web API em C# utilizando ASP.NET Core.
- Configure a conexão com o banco de dados (banco de dados da sua escolha).
- Implemente as operações básicas de CRUD para a entidade Fornecedor (listar todos os fornecedores, buscar fornecedor por ID, adicionar fornecedor, atualizar fornecedor, excluir fornecedor).
3. Endpoints da API:
o Implemente os seguintes endpoints:
- GET /api/fornecedores: Retorna todos os fornecedores.
- GET /api/fornecedores/{id}: Retorna um fornecedor específico pelo ID.
- POST /api/fornecedores: Adiciona um novo fornecedor.
- PUT /api/fornecedores/{id}: Atualiza um fornecedor existente pelo ID.
- DELETE /api/fornecedores/{id}: Remove um fornecedor pelo ID.
4. Modelagem de Dados:
- Crie o modelo de dados Fornecedor com os seguintes atributos mínimos:
- Id (int): Identificador único do fornecedor.
- Nome (string): Nome do fornecedor.
- Email (string): Endereço de e-mail do fornecedor.
- Outros campos relevantes conforme necessário.
5. Documentação:
- Utilize Swagger para documentar os endpoints da API.
# Requisito Extra
- Criar um projeto Unity que consuma dados da API:
- Fornecedores devem aparecer como NPCs
- Devem possuir "Nome" e "Email" em cima de suas cabeças
- Devem possuir um sprite de personagem aleatório
- Devem caminhar pela tela aleatóriamente
- Utilizar o sprite sheet [Sunnyside World](https://danieldiggle.itch.io/sunnyside)
- Exemplo:
# Sprint Planning
Definine o escopo e realiza criação de tarefas no Backlog do quadro Kanbam, simulando um sprint planning da metodologia Scrum.
Foi criado um quadro Kamban contendo tarefas para as features do projeto. O padrão escolhido para a escrita de todas as stories é:
* Justificativa: Resumo breve da necessidade dessa implementação, a nível de produto
* Definições Técnicas: Detalha informações a nível de desenvolvimento, incluindo requisitos a nível de código, o que ser utilizado e qual versão
* Definições Visuais (se houver): Demonstra um exemplo estético da implementação
# Arquitetura
Foi utilizado o draw.io para realizar o planejamento da arquietura própria desse projeto, com inspiração na arquitetura ASP.NET MVC.
Neste projeto, as duas formas que o usuário podem interagir com a aplicação são através da interface do Swagger (com chamadas do tipo GET, PUT, POST e DELETE) ou através do jogo Unity (será demonstrado apenas chamads GET) para a WebAPI.
A WebAPI por sua vez tem requisições tratadas pelo Controller, que realizada lógica de operações diretamente com a camada ORM.
Por sua vez, a camada ORM gerencia migrations e a entrada ou saída de valores no banco de dados através do EntityFramework 6.
## Arquitetura da camada Model
Para o modelo foi criada a clase abstrata base chamada Entity, com só o atributo Id e metodos comuns. Qualquer classe que fosse criada deveria herdar ela.
Foi criada também a classe Fornecedor, com atributos nome e email, que herda dessa classe
## Arquitetura da camada ORM
Na camada ORM, utilizamos o Entityframework 6 para fazer automaticammente o gerenciamento de um banco SQLite.
Diferente do padrão ADO.NET, após mapear a nossa classe de modelo em um arquivo configuration, o EF6 cuida automaticamente de novas alterações através das migrations criadas com o comando "add-migration nomemigration"
Para facilitar os testes, foi populado inicialmente o banco por padrão com 4 fornecedores
As operações de banco podem ser chamadas através de um repositório genérico.
## Arquitetura das camadas WebAPI (Controller + API)
A Api provém chamadas GET, POST, PUT e DELETE para o caminho "/fornecedor/" na porta 5274.
Essas chamadas, por sua vez, chamam métodos do Controller, que interage diretamente com o repositório da camada ORM
## Swagger
Ao rodar o projeto e ir para o link http://localhost:5274/swagger/index.html, o desenvolvedor tem acesso as chamadas dessa API.
Para melhorar a usabilidade, foi adicionado comentários descritivos na chamada e moodo escuro ao Swagger.
Todas as chamadas demonstram estar funcionando.
## Unity Game
No projeto Unity, foi possível pegar os dados da API através da utilização de método GET da biblioteca UnityWebRequest.
Após pegarmos a lista de fornecedores, é instanciado vários personagens "Fornecedores" em posição aleatória pelo mapa.
Essa etapa pode ser testada abrindo o projeto do jogo no Unity versão 2022.2.20f1 ou [através da execução direta das binaries que disponibilizei na aba do Github de release](https://github.com/pedroka-dev/Playmove-Fornecedores-API/releases/tag/binary) em uma VM
O texto nome e email do personagem mudam de acordo com os dados da API. A cor do texto e direção que o personagem está virado mudam aleatóriamente
Arvores, pedras e folhas que estão espalhadas pelo mapa também mudam aleatoriamente.
# Débito técnico
Algumas tarefas planejadas não foram possíveis de terminar, incluindo a ideia de personagens caminhando (com animação) e cabelos aleatórios para cada personagem instanciado.
