# Overview

## Fake Store API v1.0 <a href="#fake-store-api" id="fake-store-api"></a>

> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Welcome to the **Fake Store API** documentation.\
A simple REST API that simulates an online store — provides fake products, categories, and users for testing, prototyping, and learning purposes.

Base URLs:

```
fakestoreapi.ru
fakestoreapi.ru/files/avatars/:id ( for avatars )
fakestoreapi.ru/files/products/:id ( for product images )
```

GitHub:

```
https://github.com/nodewalker/fake-store-api
```

## Authentication

* HTTP Authentication, scheme: bearer

***

The API provides functionality for:

* User authentication (`Auth`)
* User (`User`)
* Products (`Products`)
* Categories (`Categories`)
* Cart (`Cart`)

> Use the sidebar to navigate to the desired API section.\
> Each section corresponds to an `@ApiTags` tag in the NestJS controllers.

### How to Use the Documentation

1. Select the desired section from the sidebar.
2. View the list of endpoints and their descriptions.
3. For each endpoint, examples of requests and responses are available in **JavaScript** and **TypeScript**.
4. All fields and object structures are documented through DTOs and `@ApiProperty` decorators.

### Project Purpose

The Fake Store API is designed for testing and learning:

* Can be used for frontend development without a custom backend
* A great base for learning NestJS, Swagger, TypeORM, and GitBook integration

***

> Automatically generated using NestJS + Swagger + Widdershins


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fakestoreapi.ru/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.