{item.name}
14 |{item.name}
14 |${item.price}
14 |{item.email}
14 |{item.title}
22 | 23 | ))} 24 |11 | Go to 12 | GraphQL Playground. 13 |
14 | -------------------------------------------------------------------------------- /src/content/docs/en/gql/products-filter.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Filter Products 3 | description: Endpoints to filter products 4 | --- 5 | 6 | ## Filter by title 7 | 8 | By using the `products` query and passing `title` as a query parameter, you can filter for products by title. 9 | 10 | Query: 11 | 12 | ```graphql 13 | query { 14 | products(title: "Generic") { 15 | title 16 | price 17 | } 18 | } 19 | ``` 20 | 21 | ## Filter by price 22 | 23 | By using the `products` query and passing `price` as a query parameter, you can filter for products by price. 24 | 25 | Query: 26 | 27 | ```graphql 28 | query { 29 | products(price: 100) { 30 | title 31 | price 32 | } 33 | } 34 | ``` 35 | 36 | ## Filter by price range 37 | 38 | By using the `products` query and passing `price_min` and `price_max` as a query parameter, you can filter for products by price range. 39 | 40 | Query: 41 | 42 | ```graphql 43 | query { 44 | products(price_min: 100, price_max: 200) { 45 | title 46 | price 47 | } 48 | } 49 | ``` 50 | 51 | ## Filter by category 52 | 53 | By using the `products` query and passing `categoryId` as a query parameter, you can filter for products by category. 54 | 55 | Query: 56 | 57 | ```graphql 58 | query { 59 | products(categoryId: 1) { 60 | title 61 | price 62 | category { 63 | id 64 | name 65 | } 66 | } 67 | } 68 | ``` 69 | 70 | ## Join filters 71 | 72 | You can filter products using all query parameters and merge them all. 73 | 74 | Example: All products with a price between `900` and `1000`, with the title `"Generic"` and category id `1`. 75 | 76 | Query: 77 | 78 | ```graphql 79 | query { 80 | products(title: "Generic", categoryId: 1, price_min: 100, price_max: 1000) { 81 | title 82 | price 83 | category { 84 | id 85 | name 86 | } 87 | } 88 | } 89 | ``` 90 | 91 | Example: All products with a price between `900` and `1000`, and category id `1`, with a limit of `10` products and an offset of `10`. 92 | 93 | ```graphql 94 | query { 95 | products(categoryId: 1, price_min: 900, price_max: 1000) { 96 | title 97 | price 98 | category { 99 | id 100 | name 101 | } 102 | } 103 | } 104 | ``` 105 | 106 | Example: All products with a price between `100` and `1000`, and with a limit of `10` products and an offset of `10`. 107 | 108 | ```graphql 109 | query { 110 | products(offset: 10, limit: 10, price_min: 900, price_max: 1000) { 111 | title 112 | price 113 | category { 114 | id 115 | name 116 | } 117 | } 118 | } 119 | ``` 120 | -------------------------------------------------------------------------------- /src/content/docs/en/gql/products.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Products 3 | description: Endpoints for products 4 | --- 5 | 6 | ## Get all products 7 | 8 | You can access the list of 200 products by using the `products` query. 9 | 10 | Query: 11 | 12 | ```graphql 13 | query { 14 | products { 15 | id 16 | title 17 | price 18 | description 19 | images 20 | category { 21 | id 22 | name 23 | image 24 | } 25 | } 26 | } 27 | ``` 28 | 29 | Response: 30 | 31 | ```json 32 | [ 33 | { 34 | "id": 4, 35 | "title": "Handmade Fresh Table", 36 | "price": 687, 37 | "description": "Andy shoes are designed to keeping in...", 38 | "category": { 39 | "id": 5, 40 | "name": "Others", 41 | "image": "https://placeimg.com/640/480/any?r=0.591926261873231" 42 | }, 43 | "images": [ 44 | "https://placeimg.com/640/480/any?r=0.9178516507833767", 45 | "https://placeimg.com/640/480/any?r=0.9300320592588625", 46 | "https://placeimg.com/640/480/any?r=0.8807778235430017" 47 | ] 48 | } 49 | // ... 50 | ] 51 | ``` 52 | 53 | ## Get a single product 54 | 55 | You can get a single product by adding the `id` as a parameter using `product` query. 56 | 57 | Query: 58 | 59 | ```graphql 60 | { 61 | product(id: "4") { 62 | title 63 | price 64 | } 65 | } 66 | ``` 67 | 68 | Response: 69 | 70 | ```json 71 | { 72 | "data": { 73 | "product": { 74 | "id": "1", 75 | "title": "Fantastic Rubber Towels", 76 | "price": 800, 77 | "images": [ 78 | "https://api.lorem.space/image/furniture?w=640&h=480&r=5902", 79 | "https://api.lorem.space/image/furniture?w=640&h=480&r=164", 80 | "https://api.lorem.space/image/furniture?w=640&h=480&r=8528" 81 | ], 82 | "description": "The Football Is Good For Training And Recreational Purposes" 83 | } 84 | } 85 | } 86 | ``` 87 | 88 | You can use aliases to get different products in the same request, for example: 89 | 90 | Query: 91 | 92 | ```graphql 93 | { 94 | ProductA: product(id: "1") { 95 | title 96 | price 97 | } 98 | ProductB: product(id: "2") { 99 | title 100 | price 101 | } 102 | } 103 | ``` 104 | 105 | Response: 106 | 107 | ```json 108 | { 109 | "data": { 110 | "ProductA": { 111 | "title": "Fantastic Rubber Towels", 112 | "price": 800 113 | }, 114 | "ProductB": { 115 | "title": "Rustic Plastic Soap", 116 | "price": 682 117 | } 118 | } 119 | } 120 | ``` 121 | 122 | ## Create a product 123 | 124 | You can create a new product by sending an object like a parameter to the `addProduct` mutation. 125 | 126 | Mutation: 127 | 128 | ```graphql 129 | mutation { 130 | addProduct( 131 | data: { 132 | title: "New Product" 133 | price: 10 134 | description: "A description" 135 | categoryId: 1 136 | images: ["https://placeimg.com/640/480/any"] 137 | } 138 | ) { 139 | title 140 | price 141 | images 142 | category { 143 | id 144 | name 145 | image 146 | } 147 | } 148 | } 149 | ``` 150 | 151 | Response: 152 | 153 | ```json 154 | { 155 | "title": "New Product", 156 | "price": 10, 157 | "description": "A description", 158 | "images": ["https://placeimg.com/640/480/any"], 159 | "category": { 160 | "id": 1, 161 | "name": "Clothes", 162 | "image": "https://api.lorem.space/image/fashion?w=640&h=480&r=4278" 163 | }, 164 | "id": 210 165 | } 166 | ``` 167 | 168 | > Note that the `categoryId` should be an ID that exists in `categories` and the images are an array with URLs. 169 | 170 | ## Update a product 171 | 172 | You can update a product by sending an object like the following and adding the `id` as a parameter to the `updateProduct` mutation. 173 | 174 | Mutation: 175 | 176 | ```graphql 177 | mutation { 178 | updateProduct(id: "1", changes: { title: "udpate" }) { 179 | title 180 | price 181 | images 182 | } 183 | } 184 | ``` 185 | 186 | Response: 187 | 188 | ```json 189 | { 190 | "data": { 191 | "updateProduct": { 192 | "title": "udpate", 193 | "price": 800, 194 | "images": [ 195 | "https://api.lorem.space/image/furniture?w=640&h=480&r=5902", 196 | "https://api.lorem.space/image/furniture?w=640&h=480&r=164", 197 | "https://api.lorem.space/image/furniture?w=640&h=480&r=8528" 198 | ] 199 | } 200 | } 201 | } 202 | ``` 203 | 204 | > Note that it is not necessary to send all product attributes, just send the ones you want to update. 205 | 206 | ## Delete a product 207 | 208 | You can delete a product by adding the `id` as a parameter to the `deleteProduct` mutation. 209 | 210 | Mutation: 211 | 212 | ```graphql 213 | mutation { 214 | deleteProduct(id: 1) 215 | } 216 | ``` 217 | 218 | Response: 219 | 220 | ```json 221 | { 222 | "data": { 223 | "deleteProduct": true 224 | } 225 | } 226 | ``` 227 | 228 | ## Pagination 229 | 230 | APIs that use offset-based paging use the offset and limit query parameters to paginate through items in a collection. 231 | 232 | Offset-based pagination is often used where the list of items is of a fixed and predetermined length. 233 | 234 | To fetch the first page of entries in a collection, the API needs to be called with the `offset` set to 0 and the `limit` the products that you want in the response. 235 | 236 | Query: 237 | 238 | ```graphql 239 | query { 240 | products(limit: 2, offset: 0) { 241 | title 242 | price 243 | } 244 | } 245 | ``` 246 | 247 | Response: 248 | 249 | ```json 250 | { 251 | "data": { 252 | "products": [ 253 | { 254 | "title": "udpate", 255 | "price": 800 256 | }, 257 | { 258 | "title": "Rustic Plastic Soap", 259 | "price": 682 260 | } 261 | ] 262 | } 263 | } 264 | ``` 265 | 266 | To fetch the **next page** of entries, the API needs to be called with an offset parameter that equals the sum of the previous offset value and limit returned to the previous result, 267 | 268 | To get the **next page** of entries, use an offset parameter equal to the sum of the previous offset value and the limit returned to the previous result, `previous_offset + previous_limit`. 269 | 270 | > Note that the offset should be increased by the previous limit and not by the size of the entries in the response array, as this may be less than the limit. Generally, we advise using the value of the limit in the response object to increase the offset value. 271 | 272 | For example, for a pagination with 10 items per page, it looks like this: 273 | 274 | | Query | Description | 275 | | ------------------------------- | ----------------------------- | 276 | | products(limit: 10, offset: 0) | Return the first 10 products. | 277 | | products(limit: 10, offset: 10) | Return products from 10 to 20 | 278 | | products(limit: 10, offset: 20) | Return products from 20 to 30 | 279 | 280 | Or for a pagination with 20 items per page, it looks like this: 281 | 282 | | Query | Description | 283 | | ------------------------------- | ----------------------------- | 284 | | products(limit: 20, offset: 0) | Return the first 20 products. | 285 | | products(limit: 20, offset: 20) | Return products from 20 to 40 | 286 | | products(limit: 20, offset: 40) | Return products from 40 to 60 | 287 | 288 | ## Schema Product 289 | 290 | | Attribute | Type | Description | 291 | | ----------- | -------- | ------------------------- | 292 | | id | number | The id of the product. | 293 | | title | string | The name of the product. | 294 | | price | number | Price the product. | 295 | | description | string | Description the product. | 296 | | category | number | Object of category. | 297 | | images | string[] | List of images like URLs. | 298 | -------------------------------------------------------------------------------- /src/content/docs/en/gql/users.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Users 3 | description: Endpoints for Users 4 | --- 5 | 6 | ## Get all users 7 | 8 | You can access the list of users by using the `users` query. 9 | 10 | Query: 11 | 12 | ```graphql 13 | query { 14 | users { 15 | id 16 | name 17 | email 18 | } 19 | } 20 | ``` 21 | 22 | Response: 23 | 24 | ```json 25 | { 26 | "data": { 27 | "users": [ 28 | { 29 | "id": "1", 30 | "name": "Jhon", 31 | "email": "john@mail.com" 32 | }, 33 | ... 34 | ] 35 | } 36 | } 37 | ``` 38 | 39 | ## Get a single user 40 | 41 | You can get a single user by adding the `id` as a parameter to the `user` query. 42 | 43 | Query: 44 | 45 | ```graphql 46 | query { 47 | user(id: 1) { 48 | id 49 | name 50 | avatar 51 | } 52 | } 53 | ``` 54 | 55 | Response: 56 | 57 | ```json 58 | { 59 | "data": { 60 | "user": { 61 | "id": "1", 62 | "name": "Jhon", 63 | "avatar": "https://api.lorem.space/image/face?w=640&h=480&r=6355" 64 | } 65 | } 66 | } 67 | ``` 68 | 69 | ## Create a user 70 | 71 | You can create a new user by sending an object like the following to the `addUser` mutation. 72 | 73 | Mutation: 74 | 75 | ```graphql 76 | mutation { 77 | addUser( 78 | data: { 79 | name: "Nicolas" 80 | email: "nico@gmail.com" 81 | password: "123" 82 | avatar: "https://api.lorem.space/image/face?w=150&h=220" 83 | } 84 | ) { 85 | id 86 | name 87 | avatar 88 | } 89 | } 90 | ``` 91 | 92 | Response: 93 | 94 | ```json 95 | { 96 | "data": { 97 | "addUser": { 98 | "id": "10", 99 | "name": "Nicolas", 100 | "avatar": "https://api.lorem.space/image/face?w=150&h=220" 101 | } 102 | } 103 | } 104 | ``` 105 | 106 | > Note that the password is not encrypted. 107 | 108 | ## Update a user 109 | 110 | You can update a user by sending an object like the following and adding the `id` as a parameter to `updateUser` mutation. 111 | 112 | Mutation: 113 | 114 | ```graphql 115 | mutation { 116 | updateUser(id: 1, changes: { name: "change" }) { 117 | id 118 | name 119 | avatar 120 | } 121 | } 122 | ``` 123 | 124 | Response: 125 | 126 | ```json 127 | { 128 | "data": { 129 | "updateUser": { 130 | "id": "1", 131 | "name": "change", 132 | "avatar": "https://api.lorem.space/image/face?w=640&h=480&r=6355" 133 | } 134 | } 135 | } 136 | ``` 137 | 138 | > Note that it is not necessary to send all user attributes, just send the attributes that want to update. 139 | 140 | ## Check the email 141 | 142 | You can verify if an email is already registered in the API. 143 | 144 | Request: 145 | 146 | ```graphql 147 | query { 148 | isAvailable(email: "john@mail.com") 149 | } 150 | ``` 151 | 152 | Response: 153 | 154 | ```json 155 | { 156 | "data": { 157 | "isAvailable": false 158 | } 159 | } 160 | ``` 161 | 162 | This feature is so useful for features like showing a message in a form and verifying the email before creating a user. For example: 163 | 164 |  165 | 166 | ## Schema User 167 | 168 | | Attribute | Type | Description | 169 | | --------- | ------ | ----------------------------------------- | 170 | | id | number | The id of the user. | 171 | | name | string | The name of the user. | 172 | | role | string | The role of the user is customer or admin | 173 | | email | string | The email of the user. | 174 | | password | string | The password of the user. | 175 | -------------------------------------------------------------------------------- /src/content/docs/en/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Platzi Fake Store API 3 | description: A comprehensive REST API for your e-commerce or shopping website prototype. 4 | template: splash 5 | hero: 6 | tagline: The perfect API solution for your e-commerce or shopping website prototype. 7 | image: 8 | file: ../../../assets/banner.png 9 | actions: 10 | - text: View Docs 11 | link: /en/about/introduction/ 12 | icon: right-arrow 13 | variant: primary 14 | --- 15 | 16 | import { Code } from "astro/components"; 17 | import { Card, CardGrid } from "@astrojs/starlight/components"; 18 | import CategoriesAPI from "../../../components/PreviewAPI/CategoriesAPI.astro"; 19 | import ProductsAPI from "../../../components/PreviewAPI/ProductsAPI.astro"; 20 | import UsersAPI from "../../../components/PreviewAPI/UsersAPI.astro"; 21 | 22 |11 | Download the 12 | Insomnia JSON File, for import in Insomnia App. 13 |
14 | -------------------------------------------------------------------------------- /src/content/docs/en/resources/postman.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Postman 3 | description: Using Postman with our API 4 | --- 5 | 6 | ## Overview 7 | 8 | Postman is a powerful API client that simplifies the process of testing, documenting, and sharing APIs. It provides an intuitive interface for sending requests, viewing responses, and automating workflows through collections. 9 | 10 | ## Using Our Postman Collection 11 | 12 | We've prepared a comprehensive Postman collection that includes all available endpoints in our API, properly organized and documented. This collection will help you: 13 | 14 | 1. Explore our API capabilities 15 | 2. Test different endpoints with pre-configured requests 16 | 3. Understand request parameters and response formats 17 | 4. Quickly integrate our API into your applications 18 | 19 |  20 | 21 | ## Getting Started 22 | 23 | 1. Download and install [Postman](https://www.postman.com/downloads/) if you haven't already 24 | 2. Download our Postman collection by clicking the link below 25 | 3. In Postman, click "Import" and select the downloaded JSON file 26 | 4. In API_URL change the url to https://api.escuelajs.co 27 | 5. Start exploring our API endpoints! 28 | 29 | 32 | -------------------------------------------------------------------------------- /src/content/docs/en/rest/auth-jwt.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Authentication with JWT 3 | description: API endpoints for JWT-based authentication and authorization 4 | --- 5 | 6 | This API uses JSON Web Tokens (JWT) for secure authentication. The authentication flow consists of three main operations: 7 | 8 | 1. Obtaining access and refresh tokens via login 9 | 2. Accessing protected resources using the access token 10 | 3. Refreshing expired access tokens using the refresh token 11 | 12 | ## Login 13 | 14 | To authenticate a user and obtain JWT tokens, send a POST request with email and password credentials. 15 | 16 | ### Request 17 | 18 | ```sh 19 | POST https://api.escuelajs.co/api/v1/auth/login 20 | Content-Type: application/json 21 | 22 | { 23 | "email": "john@mail.com", 24 | "password": "changeme" 25 | } 26 | ``` 27 | 28 | ### Response 29 | 30 | Upon successful authentication, the server returns both access and refresh tokens: 31 | 32 | ```json 33 | { 34 | "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImlhdCI6MTY3Mjc2NjAyOCwiZXhwIjoxNjc0NDk0MDI4fQ.kCak9sLJr74frSRVQp0_27BY4iBCgQSmoT3vQVWKzJg", 35 | "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImlhdCI6MTY3Mjc2NjAyOCwiZXhwIjoxNjcyODAyMDI4fQ.P1_rB3hJ5afwiG4TWXLq6jOAcVJkvQZ2Z-ZZOnQ1dZw" 36 | } 37 | ``` 38 | 39 | > **Note:** The access token is valid for 20 days, and the refresh token is valid for 10 hours. 40 | 41 | ## Retrieving User Profile 42 | 43 | To access the authenticated user's profile, include the access token in the Authorization header using the Bearer scheme. 44 | 45 | ### Request 46 | 47 | ```sh 48 | GET https://api.escuelajs.co/api/v1/auth/profile 49 | Authorization: Bearer {your_access_token} 50 | ``` 51 | 52 | ### Response 53 | 54 | ```json 55 | { 56 | "id": 1, 57 | "email": "john@mail.com", 58 | "password": "changeme", 59 | "name": "Jhon", 60 | "role": "customer", 61 | "avatar": "https://api.lorem.space/image/face?w=640&h=480&r=867" 62 | } 63 | ``` 64 | 65 | ## Refreshing Access Token 66 | 67 | When an access token expires, you can obtain a new pair of tokens by using the refresh token. 68 | 69 | ### Request 70 | 71 | ```sh 72 | POST https://api.escuelajs.co/api/v1/auth/refresh-token 73 | Content-Type: application/json 74 | 75 | { 76 | "refreshToken": "{your_refresh_token}" 77 | } 78 | ``` 79 | 80 | ### Response 81 | 82 | ```json 83 | { 84 | "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImlhdCI6MTY3Mjc2NjAyOCwiZXhwIjoxNjc0NDk0MDI4fQ.kCak9sLJr74frSRVQp0_27BY4iBCgQSmoT3vQVWKzJg", 85 | "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjEsImlhdCI6MTY3Mjc2NjAyOCwiZXhwIjoxNjcyODAyMDI4fQ.P1_rB3hJ5afwiG4TWXLq6jOAcVJkvQZ2Z-ZZOnQ1dZw" 86 | } 87 | ``` 88 | 89 | > **Note:** The access token is valid for 20 days, and the refresh token is valid for 10 hours. 90 | 91 | ## Error Handling 92 | 93 | Common authentication errors include: 94 | 95 | - **401 Unauthorized**: Invalid credentials or expired tokens 96 | - **403 Forbidden**: Valid authentication but insufficient permissions 97 | - **400 Bad Request**: Malformed request body or headers 98 | 99 | Always ensure your application properly handles token expiration by implementing automatic token refresh when needed. 100 | -------------------------------------------------------------------------------- /src/content/docs/en/rest/categories.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Categories 3 | description: API endpoints for managing product categories 4 | --- 5 | 6 | Retrieve a list of all available categories. 7 | 8 | ##### Request 9 | 10 | ```sh 11 | [GET] https://api.escuelajs.co/api/v1/categories 12 | ``` 13 | 14 | ##### Response 15 | 16 | ```json 17 | [ 18 | { 19 | "id": 1, 20 | "name": "Clothes", 21 | "slug": "clothes", 22 | "image": "https://placehold.co/600x400" 23 | } 24 | // Additional categories... 25 | ] 26 | ``` 27 | 28 | ## Get a single category by ID 29 | 30 | Retrieve detailed information about a specific category by its ID. 31 | 32 | ##### Request 33 | 34 | ```sh 35 | [GET] https://api.escuelajs.co/api/v1/categories/{id} 36 | ``` 37 | 38 | ##### Response 39 | 40 | ```json 41 | { 42 | "id": 1, 43 | "name": "Clothes", 44 | "slug": "clothes", 45 | "image": "https://placehold.co/600x400" 46 | } 47 | ``` 48 | 49 | ## Get a single category by slug 50 | 51 | Retrieve detailed information about a specific category by its slug. 52 | 53 | ##### Request 54 | 55 | ```sh 56 | [GET] https://api.escuelajs.co/api/v1/categories/slug/{slug} 57 | ``` 58 | 59 | ##### Response 60 | 61 | ```json 62 | { 63 | "id": 1, 64 | "name": "Clothes", 65 | "slug": "clothes", 66 | "image": "https://placehold.co/600x400" 67 | } 68 | ``` 69 | 70 | ##### Response 71 | 72 | ```json 73 | 74 | ``` 75 | 76 | ## Create a category 77 | 78 | Create a new category by providing the required information. 79 | 80 | ##### Request 81 | 82 | ```sh 83 | [POST] https://api.escuelajs.co/api/v1/categories/ 84 | 85 | #Body 86 | { 87 | "name": "New Category", 88 | "image": "https://placeimg.com/640/480/any" 89 | } 90 | ``` 91 | 92 | ##### Response 93 | 94 | ```json 95 | { 96 | "name": "New Category", 97 | "slug": "new-category", 98 | "image": "https://placeimg.com/640/480/any", 99 | "id": 6 100 | } 101 | ``` 102 | 103 | > **Note:** The image field must be a valid URL to an image resource. 104 | 105 | ## Update a category 106 | 107 | Update an existing category's information by its ID. 108 | 109 | ##### Request 110 | 111 | ```sh 112 | [PUT] https://api.escuelajs.co/api/v1/categories/{id} 113 | 114 | #Body 115 | { 116 | "name": "Updated Category Name", 117 | "image": "https://placeimg.com/640/480/any" 118 | } 119 | ``` 120 | 121 | ##### Response 122 | 123 | ```json 124 | { 125 | "id": 3, 126 | "name": "Updated Category Name", 127 | "slug": "updated-category-name", 128 | "image": "https://placehold.co/600x400" 129 | } 130 | ``` 131 | 132 | ## Delete a category 133 | 134 | Remove a category from the system by its ID. 135 | 136 | ##### Request 137 | 138 | ```sh 139 | [DELETE] https://api.escuelajs.co/api/v1/categories/{id} 140 | ``` 141 | 142 | ##### Response 143 | 144 | ```json 145 | true 146 | ``` 147 | 148 | ## Get all products by category 149 | 150 | Retrieve all products that belong to a specific category with pagination support. 151 | 152 | ##### Request 153 | 154 | ```sh 155 | [GET] https://api.escuelajs.co/api/v1/categories/{id}/products 156 | ``` 157 | 158 | ##### Response 159 | 160 | ```json 161 | [ 162 | { 163 | "id": 4, 164 | "title": "Handmade Fresh Table", 165 | "slug": "handmade-fresh-table", 166 | "price": 687, 167 | "description": "Andy shoes are designed to keeping in...", 168 | "category": { 169 | "id": 1, 170 | "name": "Others", 171 | "slug": "others", 172 | "image": "https://placehold.co/600x400" 173 | }, 174 | "images": [ 175 | "https://placehold.co/600x400", 176 | "https://placehold.co/600x400", 177 | "https://placehold.co/600x400" 178 | ] 179 | } 180 | // Additional products... 181 | ] 182 | ``` 183 | 184 | ## Category Schema 185 | 186 | | Attribute | Type | Description | 187 | | --------- | ------ | ------------------------------------- | 188 | | id | number | The unique identifier of the category | 189 | | name | string | Name of the category | 190 | | image | string | URL to the category's image | 191 | | slug | string | URL-friendly version of the name | 192 | -------------------------------------------------------------------------------- /src/content/docs/en/rest/files.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Upload File 3 | description: Endpoints for file uploads and retrieval 4 | --- 5 | 6 | This endpoint allows you to upload files to the server. The uploaded files can later be referenced in other resources such as product images. 7 | 8 | ##### Request 9 | 10 | To upload a file, send a POST request to the `/files/upload` endpoint. The request must use the `multipart/form-data` content type in the header. 11 | 12 | ```sh 13 | [POST] https://api.escuelajs.co/api/v1/files/upload 14 | Content-Type: multipart/form-data 15 | #Body 16 | { 17 | "file": "30 | Open Swagger Documentation 31 |
32 | -------------------------------------------------------------------------------- /src/content/docs/en/rest/users.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Users 3 | description: API Endpoints for User Management 4 | --- 5 | 6 | Retrieve a list of all users by using the `/users` endpoint. 7 | 8 | ##### Request 9 | 10 | ```sh 11 | GET https://api.escuelajs.co/api/v1/users 12 | ``` 13 | 14 | ##### Response 15 | 16 | ```json 17 | [ 18 | { 19 | "id": 1, 20 | "email": "john@mail.com", 21 | "password": "changeme", 22 | "name": "Jhon", 23 | "role": "customer", 24 | "avatar": "https://i.imgur.com/LDOO4Qs.jpg" 25 | } 26 | // ... additional users 27 | ] 28 | ``` 29 | 30 | ## Get a Single User 31 | 32 | Retrieve a specific user by providing the user's `id` as a path parameter: `/users/{id}` 33 | 34 | ##### Request 35 | 36 | ```sh 37 | GET https://api.escuelajs.co/api/v1/users/1 38 | ``` 39 | 40 | ##### Response 41 | 42 | ```json 43 | { 44 | "id": 1, 45 | "email": "john@mail.com", 46 | "password": "changeme", 47 | "name": "Jhon", 48 | "role": "customer", 49 | "avatar": "https://i.imgur.com/LDOO4Qs.jpg" 50 | } 51 | ``` 52 | 53 | ## Create a User 54 | 55 | Create a new user by sending a POST request with the required user data to the `/users/` endpoint. 56 | 57 | ##### Request 58 | 59 | ```sh 60 | POST https://api.escuelajs.co/api/v1/users/ 61 | 62 | # Request Body 63 | { 64 | "name": "Nicolas", 65 | "email": "nico@gmail.com", 66 | "password": "1234", 67 | "avatar": "https://picsum.photos/800" 68 | } 69 | ``` 70 | 71 | ##### Response 72 | 73 | ```json 74 | { 75 | "email": "nico@gmail.com", 76 | "password": "1234", 77 | "name": "Nicolas", 78 | "avatar": "https://i.imgur.com/yhW6Yw1.jpg", 79 | "role": "customer", 80 | "id": 24 81 | } 82 | ``` 83 | 84 | > **Note:** For demonstration purposes, passwords are stored as plain text. In a production environment, always implement proper password encryption. 85 | 86 | ## Update a User 87 | 88 | Update an existing user by sending a PUT request with the updated data and specifying the user's `id` as a path parameter: `/users/{id}` 89 | 90 | ##### Request 91 | 92 | ```sh 93 | PUT https://api.escuelajs.co/api/v1/users/1 94 | 95 | # Request Body 96 | { 97 | "email": "john@mail.com", 98 | "name": "Change name" 99 | } 100 | ``` 101 | 102 | ##### Response 103 | 104 | ```json 105 | { 106 | "id": 4, 107 | "email": "john@mail.com", 108 | "password": "1234", 109 | "name": "Change name", 110 | "role": "admin", 111 | "avatar": "https://i.imgur.com/yhW6Yw1.jpg" 112 | } 113 | ``` 114 | 115 | > **Note:** You only need to include the attributes you want to update in the request body. Other attributes will remain unchanged. 116 | 117 | ## Check Email Availability 118 | 119 | Verify if an email address is already registered in the system. 120 | 121 | ##### Request 122 | 123 | ```sh 124 | POST https://api.escuelajs.co/api/v1/users/is-available 125 | 126 | # Request Body 127 | { 128 | "email": "john@mail.com" 129 | } 130 | ``` 131 | 132 | ##### Response 133 | 134 | ```json 135 | { 136 | "isAvailable": false 137 | } 138 | ``` 139 | 140 | This endpoint is particularly useful for implementing real-time email validation in registration forms, allowing you to show immediate feedback to users about email availability. 141 | 142 |  143 | 144 | ## User Schema 145 | 146 | | Attribute | Type | Description | 147 | | --------- | ------ | ------------------------------------------ | 148 | | id | number | Unique identifier for the user | 149 | | name | string | User's full name | 150 | | role | string | User's role (either "customer" or "admin") | 151 | | email | string | User's email address | 152 | | password | string | User's password | 153 | | avatar | string | URL to the user's profile image | 154 | -------------------------------------------------------------------------------- /src/content/docs/index.mdx: -------------------------------------------------------------------------------- 1 | --- 2 | title: Platzi Fake Store API 3 | description: A comprehensive REST API for your e-commerce or shopping website prototype. 4 | template: splash 5 | hero: 6 | tagline: The perfect API solution for your e-commerce or shopping website prototype. 7 | image: 8 | file: ../../assets/banner.png 9 | actions: 10 | - text: View Docs 11 | link: /en/about/introduction/ 12 | icon: right-arrow 13 | variant: primary 14 | --- 15 | 16 | import { Code } from "astro/components"; 17 | import { Card, CardGrid } from "@astrojs/starlight/components"; 18 | import CategoriesAPI from "../../components/PreviewAPI/CategoriesAPI.astro"; 19 | import ProductsAPI from "../../components/PreviewAPI/ProductsAPI.astro"; 20 | import UsersAPI from "../../components/PreviewAPI/UsersAPI.astro"; 21 | 22 |