Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abubacar-dev/desafio-backend-bolt

este é uma api rest siples sem framework usando modulos nativo do node para consumir uma api externa do github
https://github.com/abubacar-dev/desafio-backend-bolt

api api-rest github github-api http http-server javascript node node-js nodejs

Last synced: about 1 month ago
JSON representation

este é uma api rest siples sem framework usando modulos nativo do node para consumir uma api externa do github

Awesome Lists containing this project

README

        

# Desafio Back - End do Bolt
este é uma api rest siples sem framework usando modulos nativo do node para consumir uma api externa do github.

## Referência

- [GitHub API](https://docs.github.com/en/rest?apiVersion=2022-11-28)

## Documentação da API

Para testar esse projeto rode:

```bash
npm run dev
```
#### Retorna os itens requisitados

`GET http://localhost:3000/user/${name}`

| Parâmetro | Tipo | Descrição |
| :---------- | :--------- | :------------------------------------------ |
| `name` | `string` | **Obrigatório** caso não retorna **404**. |

#### Retorna os itens com a pagina indicada

`GET http://localhost:3000/user/${name}?page={page}`

| Parâmetro | Tipo | Descrição |
| :---------- | :--------- | :------------------------------------------ |
| `page` | `string ou number` | **Não obrigatório** por padrão retorna `page = 1`. |

## Apêndice

- node version require > v16 (LTS)

## Autores

- [@mussinady-abubcar](https://www.github.com/mussinady-abubcar)

## Etiquetas

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

## Demonstração

![](.github/api-gif.gif)

Developed with ❤️ by Mussinady Abubacar