Snkr Magnet API

Instalação

1. Clone o repositório:

git clone https://github.com/JeanCSF/snkr_magnet_API.git

2. Instale as dependências:

npm install

3. Será necessário configurar algumas variáveis de ambiente. Crie um arquivo .env com as seguintes variáveis:

DB_USER=Seu_usuário_do_banco_de_dados_MongoDB
DB_PASSWORD=Sua_senha_do_banco_de_dados_MongoDB

Execução

Inicie o servidor: OBS.: Os scripts de raspagem estão em outro repositório, por questões monetarias seria inviável manter os scripts em ambiente de produção. Este repositório contém arquivos da API apenas

Caso você tenha configurado as variaves do banco de dados corretamente, basta iniciar a aplicação que já estará funcinando. Se não tiver configurado o banco a API não terá nenhuma base de dados para servir.*

npm start
ou
npm run dev

A API estará disponível em http://localhost:3000.

Endpoints

• /sneakers: Obter todos os sneakers.
• /sneakers/search/:search: Pesquisar por sneakers.
• /sneaker/:id: Obter um sneaker pelo seu ID.
• /sneakers/categories: Obter lista de todas as categorias de sneakers.
• /sneakers/category/:category: Obter todos os sneakers da categoria especificada.
• /sneakers/stores: Obter lista de todas as lojas de sneakers.
• /sneakers/store/:store: Obter todos os sneakers de uma loja especifica.
• /sneakers/brands: Obter lista de todas as marcas de sneakers.
• /sneakers/brand/:brand: Obter todos os sneakers de uma marca especifica.

Parâmetros de Consulta

• page (opcional): Número da página para paginação. O padrão é 1.
• limit (opcional): Número máximo de itens por página. O padrão é 10.
• minPrice (opcional): Preço mínimo do sneaker.
• maxPrice (opcional): Preço máximo do sneaker.
• color (opcional): Cor(es) do sneaker. Pode ser uma ou várias cores.
• size (opcional): Tamanho(s) do sneaker. Pode ser um ou vários tamanhos.
• brand (opcional): Marca(s) do sneaker. Pode ser uma ou várias marcas.
• orderBy (opcional): Ordenar os sneakers por preço ou data. Os valores permitidos são price-asc, price-desc, date-asc e date-desc. O padrão é date-desc.

Exemplo de Requisição

GET /sneakers?page=1&limit=10&minPrice=50&maxPrice=200&color=blue&size=42&brand=Nike&orderBy=price-desc

Exemplo de Resposta

[
    {
        "_id": "string",
        "srcLink": "string",
        "productReference": "string",
        "store": "string",
        "brands": ["string"],
        "img": "string",
        "sneakerTitle": "string",
        "categories": ["string"],
        "colors": ["string"],
        "currentPrice": 50.0,
        "discountPrice": 45.0,
        "priceHistory": [
            {
                "price": 50.0,
                "date": "2024-04-30T12:00:00Z",
                "_id": "string"
            }
        ],
        "availableSizes": [42],
        "codeFromStore": "string",
        "createdAt": "2024-04-30T12:00:00Z",
        "updatedAt": "2024-04-30T12:00:00Z",
        "__v": 0
    }
]

Códigos de Resposta

• 200 OK: Sucesso ao obter a lista de sneakers.

Contribuindo

Se você deseja contribuir com o projeto, siga estas etapas:

1. Faça um fork do repositório.
2. Crie uma branch para sua nova funcionalidade: git checkout -b feature/nova-funcionalidade.
3. Commit suas mudanças: git commit -m 'Adicionando nova funcionalidade'.
4. Faça push para a branch: git push origin feature/nova-funcionalidade.
5. Envie um pull request.

Licença

Este projeto está licenciado sob a Licença MIT.