gym pass api

Gym-Pass Api 2.0

API for the management of check-in in gyms, made in .NET 8 is a recreation of an old API made in Node.js. It is possible to manage gyms, checks and user information, addressing concepts such as CQRS, RBAC, DDD and Solid Princes.

Used Technologies

• .NET 8
• ASP.net
• Xunit (Unit Testing)
• Entity Framework Core
• Swagger (API documentation)

Used concepts

• Domain-Driven Design (DDD)
• Solid Principles
• ROLE-BASED ACESS CONTROLL (RBAC)
• Command Query Responsibility Segregation (CQRS)

User

Method	Path	Action
Post	/API/V1/Register	Performs the registration of a new user
Post	/API/V1/Session	Performs the user authentication
Get	/API/V1/user/profile	Rescue user information

Gyms

Method	Path	Action
Post	/API/V1/Gyms	Register a new gym (only admin)
Get	/API/V1/Nearby	Search the proxmia academies based on the user's location
Get	/API/V1/Search	Search for Academies

Check-Ins

Method	Path	Action
Post	/API/V1/check-ins	Performs the registration of a new check-in
Get	/API/V1/check-ins/user/: Userid/history	Rescues the user's check-ins history
Get	/API/V1/check-ins/user/: Userid/metrics	Rescues the user's check-ins metrics
Patch	/API/V1/check-ins/: checkinid/validate	Validates a check-in when you arrive at the gym

Application with ddd in .NET C#

 /src
  /Domain
    - Biblioteca de Classes
    - Entidades, Agregados, Repositórios (Interfaces), Serviços de Domínio
  /Application
    - Biblioteca de Classes
    - Comandos, Consultas, Manipuladores
  /Infrastructure
    - Biblioteca de Classes
    - Persistência, Repositórios (Implementações), Serviços Externos
  /Shared
    - Biblioteca de Classes
    - DTOs, Eventos, Exceções Comuns
  /API
    - WebAPI
    - Controladores, Configuração de Roteamento

1. Domain

• Project Type: Class Library

• Responsibility: Contains the fundamental business rules and the central logic of the system, including entities, value objects, aggregates and domain services.

2. Shared

• Project Type: Class Library

• Responsibility: contains reusable components throughout the application, such as DTTs, domain events, common exceptions, etc.

3. Infra (infrastructure) and Application

<<<<<< head

• Infrastructure: =======
• Infrastructure:

Origin/Main - Project Type: Class Library

 - ***Responsabilidade:*** Implementa componentes de infraestrutura, como persistência de dados (contextos de banco de dados, repositórios concretos), serviços externos e outras dependências que suportam a aplicação.

<<<<<< head

• Application: =======
• Application:

Origin/Main

 - ***Tipo de Projeto:*** Biblioteca de Classes

- ***Responsabilidade:*** Orquestra a execução das operações de negócio, utilizando comandos e consultas (em uma abordagem CQRS). Esta camada coordena a comunicação entre a camada de domínio e outras camadas.

4. API

• Project Type: Webapi

• Responsibility: Exhibit HTTP endpoints for external customers, such as front end applications or other services. Includes controllers who receive HTTP requests and orchestrate the execution of commands and consultations.

RF (Functional Requirements)

• It must be possible for the user to register;
• It should be possible for the user to authenticate;
• It should be possible to obtain the profile of a logged user;
• It should be possible to obtain the check-in number made by the logged customer;
• It should be possible for the customer to seek close gyms;
• It should be possible for the user to seek customer by name;
• It should be possible for the customer to check in at a gym;
• It should be possible to validate a customer's check-in;
• It should be possible to register a gym;
• It should be possible for the customer to get their check-in history
• It should be possible to obtain the number of check-ins made by the customer logged in

RN (Business Rules)

• The user should not register with a duplicate email;
• The user cannot do 2 check-in on the same day;
• The user should not check in if not close (100 meters) from the gym;
• Check-in can only be validated up to 20 minutes after being created;
• Check-in can only be validated by administrators;
• The gym only power registered by administrators;

RNF (nonfunctional requirements)

• The user password needs to be encrypted
• Application data need to be persisted in Bacno Postgres SQL;
• All data lists need to be page with 20 items per page;
• The user must be nominated by Token JWT (JSON Web Token);