API Whiteboard s****

Endpoints

GET /jobs

Descrição

Retorna a lista com os jobs do banco de dados

Parametros na URL

Nome Descrição Valores Exemplo
q Filtro para pesquisa String com o texto a ser pesquisado http://api-jobs.kevindantas.com/jobs?q=blabla
_sort Define por qual campo a lista será ordenada String com o nome do campo que vai ser utilizado para ordenação http://api-jobs.kevindantas.com/jobs?_sort=name
_order Define se a ordem será crescente ou decrescente Valores: desc e asc http://api-jobs.kevindantas.com/jobs?_order=desc
_page Retorna uma página especifica Número da página http://api-jobs.kevindantas.com/jobs?_page=3

Retorno

A API retorna um objeto com 2 propriedades:

  • data - Que contém a array com os dados
  • totalCount - Que contém a quantidade total de registros, que será usada como base para fazer a paginação
        
        {
          "data": [], // Array com os dados
          "totalCount": 0, // Contagem dos registros
        }
        

POST /jobs

Descrição

Cadastra uma nova empresa na lista

Corpo da requisição

Nome Tipo Descrição
name string Nome da empresa
url string URL do site da empresa
cities Array<string> Em qual cidade a empresa está localizada
countries Array<string> Em qual pais a empresa está localizada
process string Descrição do processo de contratação da empresa
keywords Array<string> Palavras chave sobre a empresa

Boa sorte!

✧*。٩(ˊᗜˋ*)و✧*。