Projects DOC

Documentação

Índice

• Guia de Desenvolvimento
  • API URLs
  • Autorizações Disponíveis
• Referência da API REST
  • Códigos de status HTTP
• Fields
• Inserir Item
  • Success
  • Bad Request
  • Unauthorized
• Listar Items
  • Success
  • Unauthorized
• Detalhar Item
  • Success
  • Unauthorized
  • Not Found
• Atualizar Item
  • Success
  • Unauthorized
  • Not Found
• Deletar Item
  • Success
  • Unauthorized
  • Not Found

Guia de Desenvolvimento

API URLs

Environment	REST
PROD	https://navedex-wes.herokuapp.com

Autorizações Disponíveis

AUTHORIZATION	Bearer JWT	URL
Bearer	jwt-token	/login/
Bearer	jwt-refresh-token	/token/refresh/

Referência da API REST

Códigos de status HTTP

• 200 Successful request
• 400 Bad request
• 401 Unauthorized
• 404 Not Found

---

Fields

Nome	Tipo	Descrição
name	String	Nome do projeto.
navers	String	Lista de navers que participaram do projeto.

Inserir Item

POST /projects/store/

Insere um item e retorna os valores inseridos.

Success

• Status Code: 201

Dados de exemplo:

{
  "name": "String",
  "navers": ["Integer",]
}

Resposta de exemplo:

{
  "id": "Integer",
  "name": "String",
  "navers": ["Integer",]
}

Bad Request

• Status Code: 400

Resposta de exemplo:

{
  "name": [
    "Este campo é obrigatório."
  ],
  "navers": [
    "Este campo é obrigatório."
  ]
}

Unauthorized

• Status Code: 401

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

Listar Items

GET /projects/show/

Retorna uma lista com todos os itens cadastrados.

Parâmetros de Filtro

Campo	Tipo	Exemplo
name	String	?name=Projeto%20bom

Success

• Status Code: 200

Resposta de exemplo:

[
  {
    "id": "Integer",
    "name": "String"
  },
  {
    "id": "Integer",
    "name": "String"
  },
  // ...
]

Unauthorized

• Status Code: 401

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

Detalhar Item

GET /projects/show/:id

Retorna o detalhe de um item.

Success

• Status Code: 200

Resposta de exemplo:

{
  "id": "Integer",
  "name": "String",
  "navers": [
    {
      "id": "Integer",
      "name": "String",
      "birthdate": "String",
      "admission_date": "String",
      "job_role": "String"
    }
    // ...
  ]
}

Unauthorized

• Status Code: 401

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

Not Found

• Status Code: 404

Resposta de exemplo:

{
  "detail": "Não encontrado."
}

Atualizar Item

PUT /projects/show/:id

Atualiza um item e retorna os valores atualizados.

Success

• Status Code: 200

Dados de exemplo:

{
  "name": "String",
  "navers": ["Integer",]
}

Resposta de exemplo:

{
  "id": "Integer",
  "name": "String",
  "navers": ["Integer",]
}

Unauthorized

• Status Code: 401

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

Not Found

• Status Code: 404

Resposta de exemplo:

{
  "detail": "Não encontrado."
}

Deletar Item

DELETE /projects/show/:id

Deletar um item cadastrado.

Success

• Status Code: 204

Resposta de exemplo:

Unauthorized

• Status Code: 401

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

Not Found

• Status Code: 404

Resposta de exemplo:

{
  "detail": "Não encontrado."
}