Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/normyee/geospot-api

A robust backend API built with Clean Architecture and DDD principles, featuring MongoDB, JWT authentication, OpenStreetMap integration, and Docker containerization.
https://github.com/normyee/geospot-api

clean-architecture ddd docker-compose geospatial jwt-authentication logging mongo-session mongodb openstreetmap-api repository-pattern routing-controllers typescript

Last synced: 3 months ago
JSON representation

A robust backend API built with Clean Architecture and DDD principles, featuring MongoDB, JWT authentication, OpenStreetMap integration, and Docker containerization.

Awesome Lists containing this project

README 

        
## šŸš€ **SoluĆ§Ć£o** 



Desenvolvi o Backend utilizando `Clean Architecture` e modelagem `DDD`, aplicando injeĆ§Ć£o de dependĆŖncias pelo mĆ³dulo `app-geo.module.ts` e implementando inversĆ£o de dependĆŖncias. Usei o padrĆ£o `Repository` para abstrair a persistĆŖncia e `MongoDB` com `sessions` para garantir a atomicidade das transaƧƵes. A autenticaĆ§Ć£o Ć© implementada com `JWT`. Para conteinerizaĆ§Ć£o, utilizei `Docker Compose`.



Integrei a `API` `OpenStreetMap` para conversĆ£o entre coordenadas e endereƧos. As rotas foram criadas com decorators e implementei um logger eficiente usando Pino. A soluĆ§Ć£o conta com vĆ”rias abstraƧƵes para garantir flexibilidade e manutenĆ§Ć£o fĆ”cil.



## šŸ” **Funcionalidades Implementadas**



### šŸ§‘ā€šŸ’» UsuĆ”rios

- **CRUD completo**.

- ConversĆ£o entre endereƧo e coordenadas via API de geolocalizaĆ§Ć£o.

- ValidaĆ§Ć£o para evitar envio de ambos ou nenhum dos dados.

- AtualizaĆ§Ć£o de localizaĆ§Ć£o segue a mesma regra.

- IntegraĆ§Ć£o com API OpenStreetMap para conversĆ£o entre endereƧo e coordenadas geogrĆ”ficas.



### šŸŒ RegiƵes

- **CRUD completo**.

- RegiƵes representadas como polƭgonos em GeoJSON, associadas a um usuƔrio.

- Listagem de regiƵes contendo um ponto especƭfico ou dentro de um raio definido.

- Listar regiƵes a uma certa distĆ¢ncia de um ponto, com opĆ§Ć£o de filtrar regiƵes nĆ£o pertencentes ao usuĆ”rio que fez a requisiĆ§Ć£o.

- **Geospatial Queries**:

  - OperaƧƵes avanƧadas utilizando ƭndices `2dsphere` para suportar consultas espaciais eficientes.

  - ImplementaĆ§Ć£o de consultas para localizaĆ§Ć£o de regiƵes e otimizaĆ§Ć£o de busca com indexaĆ§Ć£o geoespacial.



### šŸš€ Extras

- AutenticaĆ§Ć£o com JsonWebToken (usuĆ”rio pode ser passado na requisiĆ§Ć£o de criaĆ§Ć£o ou obtido no `/users/login`). āœ”ļø

- Container do MongoDB configurado com ReplicaSet SingleNode āœ”ļø.

- UtilizaĆ§Ć£o de **Mongo Sessions** para transaƧƵes. āœ”ļø

- DocumentaĆ§Ć£o completa da API por āœ”ļø.

- Cobertura de cĆ³digo (baixa cobertura de testes) āš ļø. 

- InjeĆ§Ć£o de dependĆŖncias utilizando `typedi` para melhor modularidade e testabilidade āœ”ļø

- ImplementaĆ§Ć£o de logs estruturados com `Pino` para melhor monitoramento āœ”ļø.

- Uso do `Zod` para garantir a integridade das configuraƧƵes das variĆ”veis de ambiente. āœ”ļø



### Como executar em minha mƔquina?



- Clone o projeto em sua mƔquina: `git clone https://github.com/normyee/ozmap-challenge.git`

- Entre no projeto: `cd ozmap-challenge`

`

- Crie um arquivo no pasta raiz com nome de `.env`

- Abra o `.env.example` e passe no `.env` as mesmas variƔveis

- Instale as dependĆŖncias: `yarn install`

- Inicialize o contĆŖiner: `docker-compose up --wait`

- Inicialize a aplicaĆ§Ć£o: `yarn start:prod`

  

#### Pronto šŸŽ‰

- Agora pode criar seu usuƔrio em `localhost:3003/users`

## DocumentaĆ§Ć£o

- [Como o Backend estĆ” estruturado?](doc/API-STRUCTURE.md/)



### Endpoints

- Utilize `https://geojson.io/` para obter `coordenadas` de um local nas endpoints de criaĆ§Ć£o de usuĆ”rio (`POST /users`) caso passe `coordinates` em vez do `address`. Se apenas passar o nome de um endereƧo vĆ”lido, e automaticamente as coordenadas do endereƧo serĆ£o obtidas. TambĆ©m use `https://geojson.io/` para obter pontos geomĆ©tricos para criaĆ§Ć£o de `regions`.



- **CRUD completo para rota /users**.

`POST - /users`

```

http://localhost:3000/users -> Cria um novo usuĆ”rio no sistema e retorna um Bearer Token de autenticaĆ§Ć£o em todas as outras rotas, exceto esta rota e a de 'localhost:3003/users/login'

```

#### Exemplo Request:

```

{

    "name": "fulano",

    "email": "[email protected]",

    "coordinates": [-48.47821611448057,-1.4229724705990219]

}

```

#### Response esperada:

```

{

    "status": "success",

    "message": "User has been created successfully",

    "data": {

        "id": "67d503d379222fd1a1bba282",

        "name": "fulano",

        "email": "[email protected]",

        "address": "Passagem Marinho, Sacramenta, BelĆ©m, RegiĆ£o GeogrĆ”fica Imediata de BelĆ©m, RegiĆ£o GeogrĆ”fica IntermediĆ”ria de BelĆ©m, ParĆ”, RegiĆ£o Norte, 66083-000, Brasil",

        "coordinates": [

            -48.47821611448057,

            -1.4229724705990219

        ]

    },

    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2N2Q1MDNkMzc5MjIyZmQxYTFiYmEyODIiLCJpYXQiOjE3NDIwMTMzOTUsImV4cCI6MTc0MjAzMTM5NX0.--pZDPTGmMO9u6ASWyWggna4YkbP3-dTGEcDtIevpM4"

}



```



----------------------------------------------------------------------------------

`POST - /login`

```

http://localhost:3003/auth/login-> Retorna um Bearer Token que usaremos para acessar todas as outras rotas. *OBS*: O Bearer Token tem expiraĆ§Ć£o de 5h

```



#### Exemplo Request:

```

{

    "email": "[email protected]",

}

```



#### Response esperada:

```

{

    "status": "success",

    "message": "User has signed in successfully",

    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2N2Q1MDNkMzc5MjIyZmQxYTFiYmEyODIiLCJpYXQiOjE3NDIwMTM5NjAsImV4cCI6MTc0MjAzMTk2MH0.-pG-4UP2YEob-6sPWW8ikFBf28_4CBoxZ5WDbfEjSvc"

}

```

----------------------------------------------------------------------------------

- **CRUD completo para rota /regions**.

`POST - /regions`

```

http://localhost:3003/regions-> Cria uma regiĆ£o nova associada a um user. *OBS*: Ɖ necessĆ”rio passar o Bearer Token obtido em POST "/login" ou POST "/users"

```

#### Exemplo Request:

```

{

    "name": "BelƩm Ponto",

    "geometry": {

        "type": "Polygon",

        "coordinates": [

            [

                [

                    -48.53588241001793,

                    -1.289183889687223

                ],

                [

                    -48.53588241001793,

                    -1.496723909393296

                ],

                [

                    -48.22618185632396,

                    -1.496723909393296

                ],

                [

                    -48.22618185632396,

                    -1.289183889687223

                ],

                [

                    -48.53588241001793,

                    -1.289183889687223

                ]

            ]

        ]

    }

}

```



#### Response esperada:

```

{

    "status": "success",

    "message": "Region has been created successfully",

    "data": {

        "id": "67d5075179222fd1a1bba285",

        "name": "BelƩm Ponto",

        "userId": "67d503d379222fd1a1bba282",

        "geometry": {

            "type": "Polygon",

            "coordinates": [

                [

                    [

                        -48.53588241001793,

                        -1.289183889687223

                    ],

                    [

                        -48.53588241001793,

                        -1.496723909393296

                    ],

                    [

                        -48.22618185632396,

                        -1.496723909393296

                    ],

                    [

                        -48.22618185632396,

                        -1.289183889687223

                    ],

                    [

                        -48.53588241001793,

                        -1.289183889687223

                    ]

                ]

            ]

        }

    }

}

```

----------------------------------------------------------------------------------

`GET - /regions/containing?lng=-48.4782055&lat=-1.4229802&page=1&limit=30`

```

http://localhost:3003/containing -> Retorna listagem de regiƵes contendo um ponto especƭfico ou dentro de um raio definido

```

- **ParĆ¢metros da rota**

  - `lng` -> longitude

  - `lat` -> latitude

  - `page` -> pƔgina atual da busca

  - `limit` -> limitar a quantidade por pƔgina



#### Response esperado:

```

{

    "status": "success",

    "message": "Regions containing the point [-48.4782055, -1.4229802] have been found successfully.",

    "data": [

        {

            "_id": "67d5075179222fd1a1bba285",

            "_name": "BelƩm Ponto",

            "_userId": "67d503d379222fd1a1bba282",

            "_geometry": {

                "type": "Polygon",

                "coordinates": [

                    [

                        [

                            -48.53588241001793,

                            -1.289183889687223

                        ],

                        [

                            -48.53588241001793,

                            -1.496723909393296

                        ],

                        [

                            -48.22618185632396,

                            -1.496723909393296

                        ],

                        [

                            -48.22618185632396,

                            -1.289183889687223

                        ],

                        [

                            -48.53588241001793,

                            -1.289183889687223

                        ]

                    ]

                ]

            }

        }

    ]

}

```

----------------------------------------------------------------------------------

`GET - /regions/near?lng=-48.451393226238935&lat=-1.402774657344807&km_distance=10&page=1&limit=10`

```

http://localhost:3003/containing -> Retorna listagem de regiƵes contendo um ponto especƭfico dentro de um raio definido em quilƓmetros

```

- **ParĆ¢metros da rota**

  - `lng` -> longitude

  - `lat` -> latitude

  - `km_distance` -> distĆ¢ncia em quilĆ“metros do ponto

  - `filter_user` -> `true` para filtragem regiƵes por usuƔrio

  - `page` -> pƔgina atual da busca

  - `limit` -> limitar a quantidade por pƔgina