forked from ssinuco/burger-queen-api-mock
-
Notifications
You must be signed in to change notification settings - Fork 131
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Mock da API Burger Queen | ||
|
||
Utilizando as bibliotecas [json-server](https://github.com/typicode/json-server) e [json-server-auth](https://github.com/jeremyben/json-server-auth), é criado um mock para a [API Burger Queen](https://app.swaggerhub.com/apis/ssinuco/BurgerQueenAPI/2.0.0). | ||
|
||
## Execução | ||
|
||
1. Clone o repositório | ||
2. Instale as dependências | ||
```bash | ||
npm install | ||
``` | ||
3. Execute o mock | ||
```bash | ||
npm start | ||
``` | ||
4. Agora você pode acessar os endpoints da API descritos na [documentação](https://app.swaggerhub.com/apis/ssinuco/BurgerQueenAPI/2.0.0) utilizando como URL base [http://localhost:8080/](http://localhost:8080/). | ||
|
||
Conforme indicado na documentação, os endpoints estão protegidos por token de autenticação. | ||
|
||
No arquivo [requests.http](./requests.http), você encontrará algumas solicitações de teste que pode executar diretamente no VSCode usando a extensão [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client). | ||
|
||
## Informações | ||
|
||
O mock _out-of-the-box_ fornece informações de 3 usuárias: [email protected], [email protected] e [email protected], com funções de admin, atendente e chef, respectivamente. A senha das usuárias é _123456_. | ||
|
||
Também fornece informações de 2 pedidos e 20 produtos. |