Giter Site home page Giter Site logo

mario-lacerda / proj-webpayment-api-csharp Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mpoleto/payment-api-csharp

0.0 0.0 0.0 218 KB

Projeto Web API ASP.NET realizado para o desafio final do Bootcamp Pottencial .NET Developer

License: MIT License

C# 84.82% CSS 14.39% HTML 0.78%

proj-webpayment-api-csharp's Introduction

Desafio Tech Pottencial

Projeto final do Bootcamp Pottencial .NET Developer realizado na plataforma da DIO em parceria com a Pottencial Seguradora.

🏁 Projeto Concluído

Payment API

O Projeto consiste em uma Web API construída com ASP.NET Core 6 que realiza as seguintes operações:

  • Registrar uma venda
  • Buscar uma venda pelo ID
  • Atualizar o status de uma venda

Exemplo json do método get Exemplo de um retorno do método GET

✔ Tecnologias:


  • .NET 6
  • Entity Framework Core 6
  • Banco de dados em memória do EF Core 6
  • AutoMapper
  • Swagger

Testes unitários

  • xUnit
  • Moq

🗃 Construção e Organização da API:


  • Models possui as entidades:
    • Sale - Venda
    • Seller - Vendedor
    • Product - Produto
    • EnumStatus - para os status de venda utilizei o tipo enum.
    • Interfaces das classes de repositório e serviço.
  • DTOs são as classes entidades apenas com as informações necessárias para cada método de ação da classe Controller.
  • Usei Data Annotation para validar as propriedades das classes nos diretórios Models e DTOs.

Separei a lógica de persistência das regras de negócios por meio das classes Repository e Service:

  • Persistence possui as classes que gerenciam o banco de dados:
    • PaymentContext - para criação do banco de dados e tabelas.
    • BaseRepository - classe abstrata que recebe uma instância protegida da classe contexto através de injeção de dependência.
    • SaleRepository - classe que lida com o acesso aos dados.
    • UnitOfWork - classe com o método SaveChanges() para ter certeza que as alterações só serão salvas ao fim das modificações na classe de serviço.
  • Services
    • SaleServices - lida com as regras de negócios.
  • Mapping - possui as classes que fazem o mapeamento entre as classes Models e DTOs, e as configurações necessárias para as propriedades.
  • Controllers
    • SalesController - recebe uma instância de implementação de ISaleService e IMapper.
  • Extensions
    • EnumExtensions - classe estática que possui um método, que usa a informação no data annotation do enum para apresentar os dados.
    • EnumUpdate - classe com um método para validar a atualização do status.

Testes unitários:

Classe de serviço - SaleService
Classes de mapeamento - ModelToDtoProfile e DtoToModelProfile
Classe Controller - SaleController

🖌 Swagger UI


  • Para deixar a documentação swagger mais informativa adicionei comentários xml aos métodos de ação na classe Controller.

  • Usei CSS para alterar a estilização do swagger para a API ficar mais semelhante a identidade visual da Pottencial, usei como base o próprio site da Pottencial.

Para fazer um comparativo adicionei as imagens do antes e depois:

  • Imagem da interface padrão do swagger:

Swagger UI padrão

  • Imagem com a interface da API customizada e com mais informações:

Swagger UI customizado

Este projeto está licenciado nos termos da licença MIT.

proj-webpayment-api-csharp's People

Contributors

mpoleto avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.