Skip to content

Latest commit

 

History

History
762 lines (444 loc) · 13.5 KB

postman.md

File metadata and controls

762 lines (444 loc) · 13.5 KB

Postman


Índice

Importando

Variáveis ambiente

Seções endpoints

Scripts Variáveis

Ordem de Testes

Voltar pro Readme


Importando suite

Importar suite de endpoints para o Postman (ficheiros)

  cd ./postman

Passo a Passo para importação do ficheiro do endpoint pelo GUI

import collection


Passo a Passo para importação do ficheiro do environment pelo GUI

import environment

(Opcional) Para visualizar os dados dos endpoints

  cat .\postman\api_backendflag.postman_collection.json

(Opcional) Para visualizar os dados do ambiente local do environment

  cat .\postman\api_backendflag.postman_environment.json

Início


Variáveis environments

Variáveis Descrição
apiroute Url de todos os Endpoints
api_token Token de autenticação em todos os endpoints
course_uuid UUID da secção dos cursos
student_uuid UUID da secção dos estudantes
teacher_uuid UUID da secção dos professores
subject_uuid UUID da secção das matérias
department_uuid UUID da secção dos departamentos

Início


Seções


Api Auth

API Register

Rota utilizada para registrar usuário na api


  POST /api/auth/register

Início


API Login

Rota utilizada para logar usuário na api


  GET /api/auth/login

Início


Api User

Rota retorna usuário logado na api

  GET /api/auth/me
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Api Logout

Rota Desloga o usuário da api

  POST /api/auth/logout
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Students

Students - Store

Rota cria um estudante

  POST /api/students
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Students - Index

Rota retorna todos os estudantes com os cursos ou sem.

  GET /api/students
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário
params value Descrição
with_course true Opcional. Faz com que retorne o curso de cada usuário

Início


Students - Show

Retorna o usuário encontrado pelo UUID

  GET /api/students/{{student_uuidd}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Students - Put

Rota atualiza um estudante pelo UUID

  GET /api/students/{{student_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Students - Delete

Rota deleta um estudante pelo UUID

  GET /api/students/{{student_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Courses

Courses - Store

Rota cria um curso

  POST /api/courses
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Courses - Index

Rota retorna todos os cursos com os departamentos ou sem.

  GET /api/courses
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário
params value Descrição
with_department true Opcional. Faz com que retorne o departamento de cada curso

Início


Courses - Show

Retorna o curso encontrado pelo UUID

  GET /api/courses/{{course_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Courses - Put

Rota atualiza um curso pelo UUID

  GET /api/courses/{{course_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Courses - Delete

Rota deleta um curso pelo UUID

  GET /api/courses/{{course_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Teachers

Teachers - Store

Rota cria um professor

  POST /api/teachers
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Teachers - Index

Rota retorna todos os professores com os departamentos ou sem.

  GET /api/teachers
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário
params value Descrição
with_department true Opcional. Faz com que retorne o departamento de cada professor

Início


Teachers - Show

Retorna o professor encontrado pelo UUID

  GET /api/teachers/{{teacher_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Teachers - Put

Rota atualiza um professor pelo UUID

  GET /api/teachers/{{teacher_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Teachers - Delete

Rota deleta um professor pelo UUID

  GET /api/teachers/{{teacher_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Subjects

Subjects - Store

Rota cria uma matérias

  POST /api/subjects
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Subjects - Index

Rota retorna todos as matérias com os departamentos ou sem.

  GET /api/subjects
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário
params value Descrição
with_department true Opcional. Faz com que retorne o departamento de cada matéria

Início


Subjects - Show

Retorna a matéria encontrada pelo UUID

  GET /api/subjects/{{subject_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Subjects - Put

Rota atualiza uma matéria pelo UUID

  GET /api/subjects/{{subject_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Subjects - Delete

Rota deleta uma matéria pelo UUID

  GET /api/subjects/{{subject_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Departments

Departments - Store

Rota cria um departamento

  POST /api/departments
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Departments - Index

Rota retorna todos os departamentos.

  GET /api/departments
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Departments - Show

Retorna um departamento encontrado pelo UUID

  GET /api/departments/{{department_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Departments - Put

Rota atualiza um departamento pelo UUID

  GET /api/departments/{{department_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Departments - Delete

Rota deleta um departamento pelo UUID

  GET /api/departments/{{department_uuid}}
Headers value Descrição
Authorization Bearer {{api_token}} Obrigatório. Token do usuário

Início


Scripts

Os endpoints Register e Login teem esse script que preenche a variável {{ api_token }} automaticamente assim que é feito a requisição de login ou register para facilitar o acesso ao resto das rotas!

var response = JSON.parse(responseBody);

postman.setEnvironmentVariable('api_token', response.data.token);

Todos os endpoints - Store teem esse script para preencher as variáveis {{ [name]_uuid }}

Agilizando o acesso as rotas de pesquisa, atualização e de remoção dos recursos.

exemplo :

var response = JSON.parse(responseBody);

postman.setEnvironmentVariable('student_uuid', response.data.student.uuid);

Início


Ordem de Uso

Por questão dos scripts e variáveis recomendo que sigam esse cronograma para um perfeito funcionamento da collection.

Register ou Login

Assim será preenchido a variável do Token de todas as rotas.

Store, sempre primeiro!

Assim será preenchido a variável do UUID da secção.


Início