Giter VIP home page Giter VIP logo

api_laravel's Introduction

API de Funcionários

Bem-vindo à API de Funcionários! Esta API foi construída com Laravel e fornece endpoints para gerenciar informações de funcionários, incluindo cadastro, consulta, edição, remoção e relatório.

Configuração do Ambiente

  1. Clonar o Repositório:

    git clone https://github.com/seu-usuario/api_laravel.git
  2. Instalar Dependências:

    composer install
  3. Configurar o Banco de Dados:

    **3.1. Crie um arquivo .env na raiz do projeto (você pode copiar o .env.example e ajustar as configurações).**
    
    **3.2. Configure as credenciais do banco de dados no arquivo `.env.`**
    
    ```
    DB_CONNECTION=mysql
    DB_HOST=seu_host
    DB_PORT=sua_porta
    DB_DATABASE=seu_banco_de_dados
    DB_USERNAME=seu_usuario
    DB_PASSWORD=sua_senha
    
    
        **3.3. Execute as migrações para criar as tabelas no banco de dados:**
    
        ```bash
        php artisan migrate
        ```
    
        **3.4 Iniciar o Servidor de Desenvolvimento:**
    
        ```bash
        php artisan serve
        ```
    

Informações sobre a API

  1. Acesso

A API Funcionários estará acessível em http://127.0.0.1:8000.

  1. Endpoints disponíveis

    Listar todos os funcionários:

     Método: GET
     URL: /api/employees
    

    Cadastrar novo funcionário:

     Método: POST
     URL: /api/employees
     Parâmetros: nome, sobrenome, idade, sexo
    

    Consultar funcionário por ID:

     Método: GET
     URL: /api/employees/{id}
    

    Editar funcionário por ID:

     Método: PUT
     URL: /api/employees/{id}
     Parâmetros: nome, sobrenome, idade, sexo
    

    Remover funcionário por ID:

     Método: DELETE
     URL: /api/employees/{id}
    

    Relatório de funcionários:

     Método: GET
     URL: /api/employees/report
    

Uso

1. Postman ou Insomnia

2. curl

Exemplos

Listar todos os funcionários

curl http://127.0.0.1:8000/api/employees

Cadastrar um funcionário

curl -X POST -H "Content-Type: application/json" -d '{"nome":"João","sobrenome":"Silva","idade":30,"sexo":"masculino"}' http://127.0.0.1:8000/api/employees

Popular o Banco de Dados com Funcionários de Exemplo

Para facilitar o teste e a visualização dos endpoints da API, você pode popular o banco de dados com alguns funcionários de exemplo. Utilizamos sementes (seeds) para este propósito. Executando as Seeds

Certifique-se de que o Laravel está configurado corretamente e que o arquivo .env possui as configurações adequadas para o banco de dados. Em seguida, execute o seguinte comando no terminal:

php artisan migrate --seed

Este comando executará todas as migrações do banco de dados e, em seguida, aplicará as sementes, adicionando funcionários de exemplo à tabela.

api_laravel's People

Contributors

laisbvieira avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.