Como Criar um Projeto Laravel 11 e Configurar o Artisan para APIs

Introdução

O Laravel 11 é uma das versões mais avançadas do framework, trazendo melhorias significativas para desenvolvedores. Criar um projeto e configurar o Artisan para APIs é essencial para quem deseja desenvolver aplicações robustas e escaláveis.

Neste tutorial, você aprenderá como criar um novo projeto Laravel 11, configurar o ambiente e utilizar o Artisan para criar e gerenciar APIs.

1. Instalando o Laravel 11

Certifique-se de que você tem os requisitos básicos para o Laravel 11 instalados:

  • PHP 8.2 ou superior
  • Composer
  • Banco de dados (MySQL, PostgreSQL, etc.)

Para criar um novo projeto Laravel 11, execute:


composer create-project laravel/laravel nome-do-projeto

Após a instalação, entre no diretório do projeto:


cd nome-do-projeto

2. Configurando o Ambiente

Abra o arquivo .env e configure as variáveis de ambiente para o banco de dados:


DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=nome_do_banco
DB_USERNAME=usuario
DB_PASSWORD=senha

Execute o servidor local do Laravel para garantir que tudo está funcionando:


php artisan serve

Acesse http://localhost:8000 no navegador para ver a página inicial do Laravel.

3. Instalando o Artisan API

No Laravel 11, um novo comando foi introduzido para configurar rapidamente APIs no projeto. Este comando simplifica a instalação de pacotes e configurações essenciais.

Executando o comando de instalação

Use o comando abaixo para configurar automaticamente o ambiente de API no Laravel 11:

php artisan install:api 

O comando acima realiza as seguintes ações

  • Instala o pacote laravel/sanctum para autenticação de APIs.
  • Publica o arquivo de configuração do Sanctum.
  • Executa as migrações necessárias.
  • Configura o middleware padrão para proteger as rotas de API.

Testando a Configuração

Após executar o comando php artisan install:api, teste o ambiente executando:

 php artisan serve 

Acesse as rotas de API e verifique se as configurações estão funcionando corretamente.

4. Criando Controladores e Rotas de API

Gerando um controlador

Crie um controlador para gerenciar as operações de uma entidade:


php artisan make:controller Api/PostController --api

O comando acima cria um controlador com os métodos básicos para APIs REST (index, store, show, update, destroy).

Definindo rotas

Adicione as rotas no arquivo routes/api.php:


use App\Http\Controllers\Api\PostController;

Route::apiResource('posts', PostController::class);

5. Configurando o Middleware Sanctum

Para proteger suas rotas de API, adicione o middleware auth:sanctum no api.php:


Route::middleware('auth:sanctum')->group(function () {
    Route::apiResource('posts', PostController::class);
});

Certifique-se de que seu modelo User está configurado para usar tokens Sanctum:


use Laravel\Sanctum\HasApiTokens;

class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;
}

6. Testando a API

Use ferramentas como Postman ou Insomnia para testar sua API. Tente acessar as rotas criadas e verificar as respostas.

Exemplo de requisição GET para listar todos os posts:


curl -X GET http://localhost:8000/api/posts

7. Dicas e Boas Práticas

  • Use o pacote spatie/laravel-query-builder para facilitar filtros e ordenações em APIs.
  • Implemente testes com php artisan make:test para validar as rotas e lógicas da API.
  • Documente sua API com ferramentas como Swagger ou Scribe.

Publicar comentário