dummyJSON.json

{
    "openapi": "3.0.0",
    "info": {
        "title": "DummyJSON API",
        "version": "0.0.5",
        "description": "DummyJSON API"
    },
    "externalDocs": {
        "description": "swagger.json",
        "url": "/api-docs/swagger.json"
    },
    "paths": {
        "/auth/login": {
            "post": {
                "summary": "login",
                "tags": [
                    "Login"
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "password": {
                                        "type": "string"
                                    },
                                    "username": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/User"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        },
        "/products": {
            "get": {
                "summary": "get all products",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "query",
                        "name": "limit",
                        "schema": {
                            "type": "number"
                        },
                        "required": false
                    },
                    {
                        "in": "query",
                        "name": "skip",
                        "schema": {
                            "type": "number"
                        },
                        "required": false
                    },
                    {
                        "in": "query",
                        "name": "select",
                        "schema": {
                            "type": "string"
                        },
                        "required": false
                    }
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Products"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        },
        "/products/search": {
            "get": {
                "summary": "search products",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "query",
                        "name": "q",
                        "description": "searchQuery",
                        "schema": {
                            "type": "string"
                        },
                        "required": false
                    },
                    {
                        "in": "query",
                        "name": "limit",
                        "schema": {
                            "type": "number"
                        },
                        "required": false
                    },
                    {
                        "in": "query",
                        "name": "skip",
                        "schema": {
                            "type": "number"
                        },
                        "required": false
                    },
                    {
                        "in": "query",
                        "name": "select",
                        "schema": {
                            "type": "string"
                        },
                        "required": false
                    }
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Products"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        },
        "/products/categories": {
            "get": {
                "summary": "get all products categories",
                "tags": [
                    "Product"
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "type": "array",
                                    "items": {
                                        "type": "string"
                                    }
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        },
        "/products/{product_id}": {
            "put": {
                "summary": "update a product",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "product_id",
                        "schema": {
                            "type": "integer"
                        },
                        "required": true
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Product"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Product"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            },
            "patch": {
                "summary": "update a product",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "product_id",
                        "schema": {
                            "type": "integer"
                        },
                        "required": true
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Product"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Product"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            },
            "delete": {
                "summary": "delete a product",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "product_id",
                        "schema": {
                            "type": "integer"
                        },
                        "required": true
                    }
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/ProductDelete"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            },
            "get": {
                "summary": "get product by id",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "product_id",
                        "schema": {
                            "type": "integer"
                        },
                        "required": true
                    },
                    {
                        "in": "query",
                        "name": "select",
                        "schema": {
                            "type": "string"
                        },
                        "required": false
                    }
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Product"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        },
        "/products/category/{category_name}": {
            "get": {
                "summary": "get products of category",
                "tags": [
                    "Product"
                ],
                "parameters": [
                    {
                        "in": "path",
                        "name": "category_name",
                        "description": "categoryName",
                        "schema": {
                            "type": "string"
                        },
                        "required": true
                    },
                    {
                        "in": "query",
                        "name": "select",
                        "schema": {
                            "type": "string"
                        },
                        "required": false
                    }
                ],
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Products"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        },
        "/products/add": {
            "post": {
                "summary": "create a new product",
                "tags": [
                    "Product"
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/Product"
                            }
                        }
                    }
                },
                "responses": {
                    "200": {
                        "description": "success",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Product"
                                }
                            }
                        }
                    },
                    "500": {
                        "description": "error"
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "User": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number"
                    },
                    "email": {
                        "type": "string"
                    },
                    "firstName": {
                        "type": "string"
                    },
                    "gender": {
                        "type": "string"
                    },
                    "image": {
                        "type": "string"
                    },
                    "lastName": {
                        "type": "string"
                    },
                    "token": {
                        "type": "string"
                    },
                    "username": {
                        "type": "string"
                    }
                }
            },
            "Products": {
                "type": "object",
                "properties": {
                    "products": {
                        "type": "array",
                        "items": {
                            "$ref": "#/components/schemas/Product"
                        }
                    },
                    "total": {
                        "type": "number"
                    },
                    "skip": {
                        "type": "number"
                    },
                    "limit": {
                        "type": "number"
                    }
                }
            },
            "Product": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "number"
                    },
                    "title": {
                        "type": "string"
                    },
                    "description": {
                        "type": "string"
                    },
                    "price": {
                        "type": "number"
                    },
                    "discountPercentage": {
                        "type": "number"
                    },
                    "rating": {
                        "type": "number"
                    },
                    "stock": {
                        "type": "number"
                    },
                    "brand": {
                        "type": "string"
                    },
                    "category": {
                        "type": "string"
                    },
                    "thumbnail": {
                        "type": "string"
                    },
                    "images": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        }
                    }
                }
            },
            "ProductDelete": {
                "allOf": [
                    {
                        "$ref": "#/components/schemas/Product"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "isDeleted": {
                                "type": "boolean"
                            },
                            "deletedOn": {
                                "type": "string"
                            }
                        }
                    }
                ]
            }
        }
    },
    "tags": [
        {
            "name": "Product",
            "description": "The product API"
        }
    ]
}