Skip to content

API RESTful que será integrada e consumida pelo java swing

License

Notifications You must be signed in to change notification settings

epicestudar/Hostly-spring-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation




logo

backend documentação mobile site






Typing SVG

Documentação da API - Sistema de Controle de Reservas de Hotel

Visão Geral do Projeto

Objetivo: A API do Sistema de Controle de Reservas de Hotel é responsável por permitir a autenticação de hóspedes, gerenciar reservas e listar quartos disponíveis. O sistema é integrado a uma interface em Java Swing usada por administradores para operações CRUD de hóspedes e quartos. Esta API utiliza Spring Boot e conecta-se ao MongoDB para persistência de dados.






Typing SVG

  • Java 17 (ou superior)
  • Spring Boot
    • Spring Web
    • Spring Data MongoDB
    • Spring DevTools
    • Lombok
    • Thymeleaf
  • MongoDB
  • Maven para gerenciamento de dependências
  • Thunder Client para testes de API





Typing SVG

Clone o repositório:

git clone https://github.com/epicestudar/Hostly-spring-API.git

Acesse o diretório:

cd hostly_api

Configure o application.properties:

spring.data.mongodb.uri=mongodb://localhost:27017/hostly

Instale as dependências no seu terminal:

mvn clean install

Execute o projeto:

mvn spring-boot:run

- Certifique-se de ter o git e maven instalados.






Typing SVG

4.1 Cadastro do Administrador

POST /api/administrador

Cadastra um administrador no sistema.

  • URL para o Thunder Client:
    http://localhost:8080/api/administrador

Request Body:

{
  "email": "admin@hotel.com",
  "senha": "12345678"
}

Response (201):

{
  "mensagem": "Administrador cadastrado com sucesso!"
}






4.2 Cadastro do Hóspede

POST /api/hospedes

Cadastra um hóspede no sistema.

  • URL para o Thunder Client:
    http://localhost:8080/api/hospedes

Request Body:

{
    "nome": "Vinicius",
    "dataNascimento": "2006-02-06",
    "telefone": "5519982501287",
    "cpf": "12345678901",
    "email": "vini@email.com",
    "senha": "12345678"   
}

Response (201):

{
  "mensagem": "Hóspede cadastrado com sucesso!"
}






4.3 Cadastro do Quarto

POST /api/quartos

Cadastra um quarto no sistema.

  • URL para o Thunder Client:
    http://localhost:8080/api/quartos

Request Body:

{
    "codigoQuarto": "2A",
    "tipoQuarto": "SUITE",
    "capacidadeQuarto": 3,
    "valorQuarto": 400.0
}

Response (201):

{
  "mensagem": "Quarto cadastrado com sucesso!"
}






4.4 Realização de Reserva

POST /api/reservas

Realizar uma reserva de quarto.

  • URL para o Thunder Client:
    http://localhost:8080/api/reservas

Request Body:

{
   {
    "id": "id_gerado_automaticamente",
    "quarto": {
      "id": "id_respectivo_do_quarto",
      "codigoQuarto": "2A",
      "tipoQuarto": "SUITE",
      "capacidadeQuarto": 3,
      "valorQuarto": 400.0,
      "status": "RESERVADO",
      "reservas": null
    },
    "hospede": {
      "id": "id_respectivo_do_hospede",
      "nome": "Vinicius",
      "dataNascimento": "2006-02-06",
      "telefone": "5519982501287",
      "cpf": "12345678901",
      "email": "vini@email.com",
      "senha": "12345678",
      "reservas": null
    },
    "quantidadeDiarias": 3,
    "dataCheckIn": "2024-10-16",
    "dataCheckOut": null,
    "status": "CONFIRMADO",
    "dataReserva": "2024-10-16"
  }
}

Response (201):

{
  "mensagem": "Reserva realizada com sucesso!"
}






About

API RESTful que será integrada e consumida pelo java swing

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages