https://github.com/yanbrasiliano/code-challenge-api-ibge

This API is designed to consume the IBGE (Brazilian Institute of Geography and Statistics) API and execute various internal directives to process and manage data. Developed as part of a challenge for a Junior Backend position, this project demonstrates the ability to integrate external APIs, handle data processing, and implement backend logic effic
https://github.com/yanbrasiliano/code-challenge-api-ibge

code-challenge laravel laravel-framework-8

Last synced: about 4 hours ago
JSON representation

This API is designed to consume the IBGE (Brazilian Institute of Geography and Statistics) API and execute various internal directives to process and manage data. Developed as part of a challenge for a Junior Backend position, this project demonstrates the ability to integrate external APIs, handle data processing, and implement backend logic effic

• Host: GitHub
• URL: https://github.com/yanbrasiliano/code-challenge-api-ibge
• Owner: yanbrasiliano
• License: mit
• Created: 2022-07-25T17:16:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-04T03:02:31.000Z (5 months ago)
• Last Synced: 2024-06-04T04:23:14.648Z (5 months ago)
• Topics: code-challenge, laravel, laravel-framework-8
• Language: PHP
• Homepage:
• Size: 106 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# API Address IBGE Challenge 🏆

This API is designed to consume the IBGE API and execute various internal directives. This repository is a challenge for a Junior Backend position.

## Requirements

1. **Import your state's IBGE municipalities**:

   - Create communication with the IBGE API.

   - Create an artisan command to import your municipalities.

   - Save the cities in the DB.

   - Example API: [IBGE Municipalities](https://servicodados.ibge.gov.br/api/v1/localidades/estados/BA/municipios)

2. **Create an API for address registration**:

   - Implement endpoints for the four operations: create, update, delete, and list addresses.

   - Save the following data: street address, number, district, and city ID.

   - Implement an endpoint to list cities.

   - Validate received data in create and update address endpoints.

   - Implement unit tests.

3. **Endpoints to test**:

   - `GET /api/municipality` - Get all municipalities.

   - `GET /api/municipality/{id}` - Get municipality by ID.

   - `DELETE /api/municipality/{id}` - Delete municipality by ID.

   - `PUT /api/municipality/{id}` - Update municipality by ID.

   - `POST /api/municipality` - Create a new municipality.

4. **Command to import IBGE municipalities**:

   - Run the command: `php artisan get:data`

## Technology Stack

- **Framework**: Laravel 8

- **Database**: PostgreSQL

- **Company**: Confidential