Este projeto disponibiliza uma API REST que permite o acesso as cidades e estados integrando com a API de localidades do IBGE, e também a criação de endereços.
Recursos disponíveis para acesso via API:
- Cidade
- Estado
- Endereço
Requisições para a API devem seguir os padrões:
Método | Descrição |
---|---|
GET |
Retorna informações de um ou mais registros. |
POST |
Utilizado para criar um novo registro. |
PUT |
Atualiza dados de um registro ou altera sua situação. |
DELETE |
Remove um registro do sistema. |
Código | Descrição |
---|---|
200 |
Requisição executada com sucesso (success). |
201 |
Registro criado com sucesso (success). |
202 |
Registro editado com sucesso (success). |
204 |
Registro deletado com sucesso (success). |
400 |
Erros de validação ou os campos informados não existem no sistema. |
401 |
Dados de acesso inválidos. |
404 |
Registro pesquisado não encontrado (Not found). |
405 |
Método não implementado. |
422 |
Dados informados estão fora do escopo definido para o campo. |
429 |
Número máximo de requisições atingido. (aguarde alguns segundos e tente novamente) |
1 - Realize o download do docker
, aconselhavel caso utilizar windows utilizar a distro UBUNTU.
2 - Realize o clone do projeto da forma que for melhor para você
3 - Configure o ambiente do laradock executando o script shell 'initLaradock.sh' na raiz do projeto. Caso ocorra algum erro efetue a instalação manual do laradock
INSTALAÇÃO MANUAL DO AMBIENTE LARADOCK
3.1 - Clone o diretório do laradock
Utilizando o composer local
git clone https://github.com/Laradock/laradock.git ./laradock;
Caso ocorra algum erro, é necessário fazer a configuração do ambiente manualmente
3.2 - Copie o .env.laradock para o .env do laradock
cp .env.laradock ./laradock/.env;
3.3 - Entre na pasta laradock e suba os containers
cd ../laradock; # Entra na pasta laradock docker-compose up -d nginx mysql; # Faz o build dos container e sobe eles
4 - Instale as dependências do PHP via composer executando o comando dentro do container 'workspace'
docker exec -it <container id> bash # Comando para entrar dentro do container, verifique o container id do workspace utilizando 'docker ps' composer install
5 - Execute as migrations dentro do container 'workspace'
Utilizando o artisan
php artisan migrate
- PHP: 8.1
- Laravel: 9.9.0
- Composer: 2.2.6
- Laradock
- Docker
- Bash
- MySQL
- Nginx