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

https://github.com/dnowdd/pavot-api

Pavot API in Laravel
https://github.com/dnowdd/pavot-api

Last synced: 10 months ago
JSON representation

Pavot API in Laravel

Awesome Lists containing this project

README

          


Laravel Logo

# Pavot API

API robusta desenvolvida com Laravel, PHP moderno e arquitetura orientada a objetos.

## Tecnologias Utilizadas

- **PHP** (>=8.1)
- **Laravel** (Framework web moderno e robusto)
- **Composer** (Gerenciador de dependências PHP)
- **MySQL** (Banco de dados relacional)

## Linguagens

- **PHP**: Backend e lógica da API
- **SQL**: Utilizado para persistência de dados no MySQL

## Como rodar o projeto

### Pré-requisitos

- PHP >= 8.1
- Composer instalado
- MySQL rodando localmente

### Passos

1. **Clone o repositório:**

```bash
git clone
cd pavot-api
```

2. **Instale as dependências:**

```bash
composer install
```

3. **Configure o ambiente:**

- Renomeie o arquivo `.env.example` para `.env` (se necessário)
- Edite o `.env` conforme sua configuração de banco:
```env
DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=pavot
DB_USERNAME=root
DB_PASSWORD=
```

4. **Gere a chave da aplicação:**

```bash
php artisan key:generate
```

5. **Execute as migrations (opcional):**

```bash
php artisan migrate
```

6. **Inicie o servidor:**

```bash
php artisan serve --host=0.0.0.0 --port=8000
```

7. **Acesse o endpoint de teste:**
- Endpoint: `GET /api/helloworld`
- Exemplo:
```bash
curl http://localhost:8000/api/helloworld
# Resposta: { "message": "helloworld" }
```

## Estrutura do Projeto

- `routes/api.php`: Definição das rotas da API
- `app/`: Código principal da aplicação
- `.env`: Configurações de ambiente

## Observações

- O projeto já está pronto para integração com MySQL.
- Para criar novos endpoints, edite o arquivo `routes/api.php` ou crie Controllers em `app/Http/Controllers`.
- Recomenda-se utilizar migrations para gerenciar o banco de dados.

---

Feito com ❤️ por David Queiroz.