项目作者: hernanbs

项目描述 :
API REST feita usando java.
高级语言: Java
项目地址: git://github.com/hernanbs/gestao-patrimonio-server.git
创建时间: 2020-08-17T00:03:44Z
项目社区:https://github.com/hernanbs/gestao-patrimonio-server

开源协议:MIT License

下载


API REST Gestão de Patrimônio


GitHub language count
GitHub code size in bytes
GitHub

:computer: Introdução

Aplicação Web Rest que disponibiliza acesso a dados de Marcas e Patrimônios por meio de requisições HTTP em um formato padronizado JSON.
Projeto feito inteiramente com java utilizando banco de dados PostgreSQL.

:rocket: Instalação

HTTP Endpoints

:pushpin: Marca

Verbos HTTP URI
01 GET http://localhost:8080/projeto-gestao-patrimonio/rest/marcas
02 GET http://localhost:8080/projeto-gestao-patrimonio/rest/marcas/{id}
03 GET http://localhost:8080/projeto-gestao-patrimonio/rest/marcas/{id}/patrimonios
04 POST http://localhost:8080/projeto-gestao-patrimonio/rest/marcas
05 PUT http://localhost:8080/projeto-gestao-patrimonio/rest/marcas/{id}
06 DELETE http://localhost:8080/projeto-gestao-patrimonio/rest/marcas/{id}

01 - Listar todas as marcas

  • Não necessita de body na requisição
  • Retorno no formato:
    1. [
    2. {
    3. "id": "conteudo",
    4. "nome": "conteudo"
    5. }
    6. ]

    02 - Pesquisar uma marca usando seu Id

    • Necessário adicionar id na url da requisição
    • Não necessita de body na requisição
    • Retorno no formato:
      1. {
      2. "id": "conteudo",
      3. "nome": "conteudo"
      4. }

      03 - Pesquisar patrimônios usando o Id de sua marca

    • Necessário adicionar id na url da requisição
    • Não necessita de body na requisição
    • Retorno no formato:
      1. [
      2. {
      3. "id": 1,
      4. "idMarca": 1,
      5. "nome": "conteudo",
      6. "descricao": "conteudo",
      7. "numTombo": 1000000
      8. }
      9. ]

      04 - Adiciona uma marca a base de dados

    • body da requisição necessário
      1. {
      2. "nome": "conteudo"
      3. }
    • Retorno no formato inteiro, numero de id

      05 - Editar uma marca existente da base de dados

    • Necessário adicionar id na url da requisição
    • body da requisição necessário
      1. {
      2. "nome": "conteudo"
      3. }
    • retorno sem conteudo

      06 - Remover uma marca da base de dados

    • Necessário adicionar id na url da requisição
    • Não necessita de body na requisição
    • retorno sem conteudo

:pushpin: Patrimônio

Verbos HTTP URI
01 GET http://localhost:8080/projeto-gestao-patrimonio/rest/patrimonios
02 GET http://localhost:8080/projeto-gestao-patrimonio/rest/patrimonios/{id}
03 POST http://localhost:8080/projeto-gestao-patrimonio/rest/patrimonios
04 PUT http://localhost:8080/projeto-gestao-patrimonio/rest/patrimonios/{id}
05 DELETE http://localhost:8080/projeto-gestao-patrimonio/rest/patrimonios/{id}

01 - Listar todos os patrimônios

  • Não necessita de body na requisição
  • Retorno no formato:
    1. [
    2. {
    3. "id": 1,
    4. "idMarca": 1,
    5. "nome": "conteudo",
    6. "descricao": "conteudo",
    7. "numTombo": 1000000
    8. }
    9. ]

    02 - Pesquisar um patrimônio usando seu Id

    • Necessário adicionar id na url da requisição
    • Não necessita de body na requisição
    • Retorno no formato:
      1. {
      2. "id": 1,
      3. "idMarca": 1,
      4. "nome": "conteudo",
      5. "descricao": "conteudo",
      6. "numTombo": 1000000
      7. }

      03 - Adiciona um patrimônio a base de dados

    • body da requisição necessário
      1. {
      2. "idMarca": 1,
      3. "nome": "conteudo",
      4. "descricao": "conteudo",
      5. }
    • Retorno no formato inteiro, número do id

      05 - Editar um patrimônio existente da base de dados

    • Necessário adicionar id na url da requisição
    • body da requisição necessário
      1. {
      2. "idMarca": 1,
      3. "nome": "conteudo",
      4. "descricao": "conteudo",
      5. }
    • retorno sem conteudo

      06 - Remover um patrimônio da base de dados

    • Necessário adicionar id na url da requisição
    • Não necessita de body na requisição
    • retorno sem conteudo

:hammer_and_wrench: STATUS DAS RESPOSTAS

  • 200: OK
  • 201: Criado
  • 204: Resposta sem conteúdo
  • 3xx: Redirection
  • 400: Má requisição
  • 404: Página não encontrada
  • 500: Erro interno do servidor