Contrata-se.dev API

Agregador de vagas para pessoas desenvolvedoras 💻😄

Rodando o projeto localmente

1 - Clone o projeto e instale as dependêcias:

$ git clone https://github.com/Kaisen-san/contrata-se-dev-api.git
$ cd contrata-se-dev-api
$ npm install

2 - Rode o servidor:

$ npm start

Consumindo a API

Atualmente, apenas as issues abertas de repositórios do GitHub são retornadas pela API.

Os formatos de request suportados são:

• Para retornar todas as issues abertas de um repositório:

  • GET --> http://localhost:4000/api/v1/github/:accountName/:repoName

• Para retornar as issues abertas de uma página específica de um repositório:

  • GET --> http://localhost:4000/api/v1/github/:accountName/:repoName/:issuePage

:accountName Nome da conta no GitHub. Exemplo: frontendbr, backend-br, LarissaAbreu

:repoName Nome de um repositório da conta acima. Exemplo: vagas (repositório tanto do frontendbr quanto do backend-br), contrata-se-dev (repositório da LarissaAbreu)

:issuePage Número de uma das páginas de issues do repositório acima (uma vez que a API do GitHub faz paginação dos resultados)

Para ambas as requisições um array com as issues abertas será retornado, cada issue contento os seguintes campos:

[
  {
    "title": "SOME_TITLE",
    "html_url": "SOME_URL",
    "created_at": "SOME_DATE",
    "labels": {
      "name": "SOME_LABEL",
      "color": "SOME_COLOR"
    }
  },
]

Utilizando o navegador ou alguma ferramenta de consumo de APIs, como Insomnia (:heart:) ou Postman, tente os seguintes exemplos:

• GET --> http://localhost:4000/api/v1/github/frontendbr/vagas/1

• GET --> http://localhost:4000/api/v1/github/frontendbr/vagas

• GET --> http://localhost:4000/api/v1/github/backend-br/vagas/21

• GET --> http://localhost:4000/api/v1/github/backend-br/vagas

Versionamento

Para manter uma melhor organização, seguiremos as diretrizes do Versionamento Semântico 2.0.0.

Contribuição

Veja nesse guia os próximos passos do projeto 😉

Quer contribuir? Siga essas recomendações.

Licença

Licença MIT © Felipe Andrade