# ejmeri/api-patinha-facil architecture

> Architecture diagram of the GitHub repository ejmeri/api-patinha-facil, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ejmeri/api-patinha-facil
- Repository: https://github.com/ejmeri/api-patinha-facil

## Overview

##### Project type and purpose
- This is a Node.js-based RESTful Web Service (“Patinha Fácil Service”) that exposes endpoints for pet adoption data (animals, persons, addresses, adoptions, users). It uses Express.js for request handling and Sequelize (via the files in `models/`) to interact with a MySQL database.

##### File structure
- **app.js**
- Entry point where Express is configured, middleware is loaded, and `routes/index.js` is mounted.
- **config/mysql.js**
- Exports the Sequelize setup (connection details, pool configuration).
- **models/**
- Divided by domain: `address/` (city, state, ddd), `animal/` (breed, specie, coat, gender, care, images), `person/` (person, contact, address, persontype), plus `adoption.js`, `user.js`, `personanimal.js`.
- `models/index.js` likely collects and associates all Sequelize models.
- **routes/index.js**
- Defines HTTP routes, probably grouped by resource (e.g., `/animals`, `/persons`, `/adoptions`, `/users`).
- **Procfile**
- Indicates deployment to Heroku (runs `node app.js`).
- **package.json / package-lock.json**
- Lists dependencies (Express, Sequelize, MySQL driver, etc.) and npm scripts.

##### README
- Confirms it’s a “Web Service” for a semester project, no front-end code here. The focus is purely backend.

## Diagram (Mermaid)

```mermaid
graph TD
    EC["External Clients"]:::external
    EA["Express.js Application\n(app.js)"]:::code
    RT["Routing Layer\n(routes/index.js)"]:::code
    CFG["Configuration Module\n(config/mysql.js)"]:::config
    PK["package.json"]:::config
    HF["Heroku Deployment\n(Procfile)"]:::deployment

    subgraph "Domain Models"
        MI["Models Aggregator\n(models/index.js)"]:::code
        subgraph "Address Domain"
            A1["City\n(models/address/city.js)"]:::code
            A2["State\n(models/address/state.js)"]:::code
            A3["DDD\n(models/address/ddd.js)"]:::code
        end
        subgraph "Animal Domain"
            AN1["Animal\n(models/animal/animal.js)"]:::code
            AN2["AnimalImage\n(models/animal/animalimage.js)"]:::code
            AN3["Breed\n(models/animal/breed.js)"]:::code
            AN4["Coat\n(models/animal/coat.js)"]:::code
            AN5["Care\n(models/animal/care.js)"]:::code
            AN6["Gender\n(models/animal/gender.js)"]:::code
            AN7["Specie\n(models/animal/specie.js)"]:::code
        end
        subgraph "Person Domain"
            P1["Person\n(models/person/person.js)"]:::code
            P2["Address\n(models/person/address.js)"]:::code
            P3["Contact\n(models/person/contact.js)"]:::code
            P4["PersonType\n(models/person/persontype.js)"]:::code
        end
        M5["Adoption\n(models/adoption.js)"]:::code
        M6["User\n(models/user.js)"]:::code
        M7["PersonAnimal\n(models/personanimal.js)"]:::code
    end

    DB[(MySQL Database)]:::db

    EC -->|"HTTP(S) requests"| EA
    EA -->|"loads routes"| RT
    EA -->|"loads config"| CFG
    EA -->|"deploys via"| HF
    RT -->|"invokes models"| MI
    CFG -->|"provides connection info"| MI
    MI -->|"CRUD operations"| DB
    PK -.->|npm scripts & deps| EA

    click EA "https://github.com/ejmeri/api-patinha-facil/blob/master/app.js"
    click RT "https://github.com/ejmeri/api-patinha-facil/blob/master/routes/index.js"
    click CFG "https://github.com/ejmeri/api-patinha-facil/blob/master/config/mysql.js"
    click MI "https://github.com/ejmeri/api-patinha-facil/blob/master/models/index.js"
    click A1 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/address/city.js"
    click A2 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/address/state.js"
    click A3 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/address/ddd.js"
    click AN1 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/animal.js"
    click AN2 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/animalimage.js"
    click AN3 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/breed.js"
    click AN4 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/coat.js"
    click AN5 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/care.js"
    click AN6 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/gender.js"
    click AN7 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/animal/specie.js"
    click P1 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/person/person.js"
    click P2 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/person/address.js"
    click P3 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/person/contact.js"
    click P4 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/person/persontype.js"
    click M5 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/adoption.js"
    click M6 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/user.js"
    click M7 "https://github.com/ejmeri/api-patinha-facil/blob/master/models/personanimal.js"
    click HF "https://github.com/ejmeri/api-patinha-facil/tree/master/Procfile"
    click PK "https://github.com/ejmeri/api-patinha-facil/blob/master/package.json"

    classDef code fill:#cfe2f3,stroke:#6495ed,color:#000;
    classDef db fill:#d5e8d4,stroke:#228B22,color:#000;
    classDef config fill:#eeeeee,stroke:#999999,color:#000;
    classDef external fill:#ffe599,stroke:#f1c232,color:#000;
    classDef deployment fill:#f4cccc,stroke:#e06666,color:#000;
```
