https://github.com/geicesousa/apiburgerladies

api
https://github.com/geicesousa/apiburgerladies

Last synced: 6 days ago
JSON representation

api

• Host: GitHub
• URL: https://github.com/geicesousa/apiburgerladies
• Owner: geicesousa
• Created: 2023-07-12T17:30:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-08-18T13:08:46.000Z (about 1 year ago)
• Last Synced: 2023-12-05T03:27:04.428Z (12 months ago)
• Language: JavaScript
• Homepage: https://api-burger-ladies.vercel.app
• Size: 216 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Burger Queen API Mock

Usando las librerías [json-server](https://github.com/typicode/json-server) 

y [json-server-auth](https://github.com/jeremyben/json-server-auth) 

se crea un mock para 

[Burger Queen API](https://app.swaggerhub.com/apis/ssinuco/BurgerQueenAPI/2.0.0)

## Ejecución

1. Clona el repositorio

2. Instala las dependencias

    ```bash

    npm install

    ```

3. Ejecuta el mock

    ```bash

    npm start

    ```

4. Ahora puedes acceder a los endpoints del API descritos en la 

[documentación](https://app.swaggerhub.com/apis/ssinuco/BurgerQueenAPI/2.0.0) 

usando como URL base [http://localhost:8080/](http://localhost:8080/).

    Tal como indica la documentación, los endpoints están protegidos 

    por token de autenticación.

    En el archivo [requests.http](./requests.http) encuentras 

    algunas peticiones de prueba que puedes ejecutar directamente 

    en VSCode usando la extensión 

    [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client).