Documentação da API - Gerenciamento Porto Seguro

Visão Geral

Esta API oferece operações de gerenciamento de clientes, bicicletas e seus dados, permitindo a criação, recuperação, atualização e exclusão de registros dos mesmos. É uma API RESTful que opera no banco de dados da Porto Seguro.

É importante observar que o banco de dados da Porto se trata de um banco com tabelas relacionadas entre si, portanto a exclusão de algum item que possua chave estrangeira apenas é permitida após a exclusão do item filho, assim como o limite hierárquico deve ser respeitado na hora de cadastrar novos dados.

Métodos

1. Listar Todos

Método: GET

BASE URL: http://localhost:8080/portoapi/webapi

URL: /clientes | /bicicletas | /modelos | /marcas | /acessorios | /vistorias | /fotos-bicicleta

Descrição: Obtém uma lista completa dos dados cadastrados no banco de dados.

Resposta de Sucesso: Código 200 (OK)

Exemplo de Resposta:

    [
        {
            "dtCadastro": "2020-01-01",
            "dtNascimento": "1980-05-20",
            // Outros campos...
        },
        // Outros clientes...
    ]

2. Obter cliente, bicicleta ou atributos por CPF, ID ou número de série

Método: GET

URL: /acessorios/{id} | /bicicletas/{nrSerie} | /clientes/{cpf} | /fotos-bicicleta/{id} | /marcas/{id} | /modelos/{id} | /vistorias{nrSerie}

Descrição: Obtém os detalhes dos acessórios, bicicletas, clientes, fotos-bicicleta, marcas, modelos ou vistorias com base no id, número de série ou CPF fornecidos.

Resposta de Sucesso: Código 200 (OK)

Exemplo de Resposta:

    {
        "dtCadastro": "2021-02-28",
        "dtNascimento": "1992-12-10",
        // Outros campos...
    }

3. Cadastrar um novo cliente, bicicleta, marcas, modelos, vistorias, acessórios ou fotos das bicicletas.

Método: POST

URL: /acessorios/{id} | /bicicletas/{nrSerie} | /clientes/{cpf} | /fotos-bicicleta/{id} | /marcas/{id} | /modelos/{id} | /vistorias{nrSerie}

Descrição: Cadastrar com os detalhes fornecidos.

Corpo da Requisição:

    {
        "dtCadastro": "2016-09-15",
        "dtNascimento": "1982-09-30",
        // Outros campos...
    }

Resposta de Sucesso: Código 201 (Created)

4. Atualizar um cliente, bicicleta, marca, modelo, vistoria, acessório ou foto das bicicletas.

Método: PUT

URL: /acessorios/{id} | /bicicletas/{nrSerie} | /clientes/{cpf} | /fotos-bicicleta/{id} | /marcas/{id} | /modelos/{id} | /vistorias{nrSerie}

Descrição: Atualiza os detalhes com base no ID, número de série ou CPF fornecido.

Corpo da Requisição (campos a serem atualizados):

    {
        "dtCadastro": "2016-09-15",
        "dtNascimento": "1982-09-30",
        // Outros campos...
    }

Resposta de Sucesso: Código 200 (OK)

5. Excluir um cliente, bicicleta, marca, modelo, vistoria, acessório ou foto das bicicletas.

Método: DELETE

URL: /acessorios/{id} | /bicicletas/{nrSerie} | /clientes/{cpf} | /fotos-bicicleta/{id} | /marcas/{id} | /modelos/{id} | /vistorias{nrSerie}

Parâmetros de URL: {id}: O ID do personagem que deseja excluir.

Descrição: Exclui um cliente, bicicleta, marca, modelo, vistoria, acessório ou foto das bicicletas com base no ID, número de série ou CPF fornecido.

Resposta de Sucesso: Código 204 (No Content)