/escola

Primary LanguagePHP

Requisitos 🐃

  • PHP: 8.1.8
  • Laravel: 9.0
  • Composer: 2.2.6
  • NodeJS: 16
  • Database: MySQL
  • Documentação: Postman
  • Línguagem: O Código deve ser escrito em PORTUGUÊS, tendo suas ressalvas para funções a nível de escopo global que pode ser escrito em Inglês.

Links Úteis 😇

MÉTODOS HTTP

GET

Código Descrição
😊 200 - OK Somente se encontrar dos no banco
😡 401 - Unauthorized Quando tentar realizar uma requisição sem estar autenticado
😖 404 - Not Found Quando não for encontrado nenhum registro
😡 500 - Server Error Quando acontecer algum erro inesperado. (Não é necessário implementar)

POST

Código Descrição
😊 102 - Processing Quando a requisição for ASSÍNCRONA e já tiver um processo em andamento
😖 200 - OK Quando a requisição for concluída mas o registro NÃO for criado
😊 201 - Created Quando a requisição for concluída e o registro FOR criado
😊 202 - Accepted Quando a solicitação de uma requisição ASSÍNCRONA for concluída
😡 400 - Bad Request Quando tentar realizar uma requisição e ocorrer algum erro relacionado a regra de negócio
😡 401 - Unauthorized Quando tentar realizar uma requisição sem estar autenticado
😖 404 - Not Found Quando não for encontrado nenhum registro para processar
😖 422 - Unprocessable Entity Quando ocorrer algum erro por conta de falha na validação do Request
😡 500 - Server Error Quando acontecer algum erro inesperado. (Não é necessário implementar)

PUT

Código Descrição
😊 200 - OK Quando a requisição for concluída com sucesso
😡 400 - Bad Request Quando tentar realizar uma requisição e ocorrer algum erro relacionado a regra de negócio
😡 401 - Unauthorized Quando tentar realizar uma requisição sem estar autenticado
😖 404 - Not Found Quando não for encontrado nenhum registro para processar
😖 422 - Unprocessable Entity Quando ocorrer algum erro por conta de falha na validação do Request
😡 500 - Server Error Quando acontecer algum erro inesperado. (Não é necessário implementar)

DELETE

Código Descrição
😖 200 - OK Quando a requisição for concluída mas o registro NÃO for deletado
😊 204 - No Content Quando a requisição for concluída e o registro FOR deletado
😡 401 - Unauthorized Quando tentar realizar uma requisição sem estar autenticado
😖 404 - Not Found Quando não for encontrado nenhum registro para processar
😖 422 - Unprocessable Entity Quando ocorrer algum erro por conta de falha na validação do Request
😡 500 - Server Error Quando acontecer algum erro inesperado. (Não é necessário implementar)

PATCH

Código Descrição
😖 200 - OK Quando a requisição for concluída mas o registro NÃO for editado
😊 204 - No Content Quando a requisição for concluída e o registro FOR editado
😡 401 - Unauthorized Quando tentar realizar uma requisição sem estar autenticado
😖 404 - Not Found Quando não for encontrado nenhum registro para processar
😖 422 - Unprocessable Entity Quando ocorrer algum erro por conta de falha na validação do Request
😡 500 - Server Error Quando acontecer algum erro inesperado. (Não é necessário implementar)

Respostas

GET 👀

Clique para expandir!
  • 200 OK
{
    "mensagem": "Registros encontrados",
    "dados": [
        {
            "MunId": 1,
            "MunNome": "Nome do registro"
        }
    ]
}
  • 404 Not Found
{
    "mensagem": "Registro não encontrado",
    "dados": []
}

POST 👀

Clique para expandir!
  • 102 Processing
{
    "mensagem": "Requisição em processamento"
}
  • 200 OK
{
    "mensagem": "O Registro não pôde ser criado"
}
  • 201 Created
{
    "mensagem": "O Registro criado",
    "dados": [
        {
            "MunId": 1,
            "MunNome": "Nome do registro"
        }
    ]
}
  • 202 Accepted
{
    "mensagem": "Requisição recebida e está em andamento"
}
  • 404 Not Found
{
    "mensagem": "Registro não encontrado"
}

PUT 👀

Clique para expandir!
  • 200 OK
{
    "mensagem": "Registro editado com sucesso",
    // Dados dos *REGISTROS* atualizados
    "dados": [
        {
            "MunId": 1,
            "MunNome": "Nome do registro"
        }
    ]
}
  • 404 Not Found
{
    "mensagem": "Registro não encontrado",
}

DELETE 👀

Clique para expandir!
  • 200 OK
{
    "mensagem": "Ocorreu um erro ao deletar o registro",
}
  • 204 No Content
 // Não informar o body da response
  • 404 Not Found
{
    "mensagem": "Registro não encontrado"
}

PATCH 👀

Clique para expandir!
  • 200 OK
{
    "mensagem": "Ocorreu um erro ao atualizar a informação",
}
  • 204 No Content
 // Não informar o body da response
  • 404 Not Found
{
    "mensagem": "Registro não encontrado"
}

GET | POST | PUT | DELETE | PATCH 👀

Clique para expandir!
  • 400 Bad Request ( Não utilizado no método GET )
{
    "mensagem": "Ocorreu um erro ao processar a requisição",
}
  • 401 Unauthorized
{
   "message": "Unauthorized"
}
  • 500 Server Error
{
   "message": "Unauthorized"
}