Evgenii-Evgenevich/micro-store

micro-store

Init

• build docker image

sudo mvn install dockerfile:build

• run docker image

sudo docker run -p 8000:8000 micro-store

RestAPI

• Create a new product // Создать новый товар
  • POST: http://localhost:8000/api/product
  • Example Request Body

{
  "characteristic": {
    "string": {}
  },
  "description": "string",
  "title": "string"
}

curl -X POST "http://localhost:8000/api/product" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"characteristic\": { \"key1\":\"value\", \"key2\":\"value\", \"key3\":\"value\" }, \"description\": \"an awesome product\", \"title\": \"product\"}"

• Example Response Body

{
  "id": "5d663c8786fc7828cc13bf75",
  "dateTime": "2019-08-28T08:34:15",
  "title": "product",
  "description": "an awesome product",
  "characteristic": {
    "key1": "value",
    "key2": "value",
    "key3": "value"
  }
}

• Get details of a pruduct by id // Получить детали товара по ID
  • GET: http://localhost:8000/api/product/{id}

curl -X GET "http://localhost:8000/api/product/5d663c8786fc7828cc13bf75" -H "accept: application/json"

• Example Response Body

{
  "id": "5d663c8786fc7828cc13bf75",
  "dateTime": "2019-08-28T08:34:15",
  "title": "product",
  "description": "an awesome product",
  "characteristic": {
    "key1": "value",
    "key2": "value",
    "key3": "value"
  }
}

• Update a pruduct by id // Изменить товар по ID
  • POST: http://localhost:8000/api/product/{id}
  • Example Request Body

{
  "characteristic": {
    "string": {}
  },
  "description": "string",
  "title": "string"
}

curl -X POST "http://localhost:8000/api/product/5d663c8786fc7828cc13bf75" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"characteristic\": { \"key1\":\"value1\", \"key2\":\"value2\", \"key3\":\"value3\" }, \"description\": \"an awesome product\", \"title\": \"product\" }"

• Example Response Body

{
  "id": "5d663c8786fc7828cc13bf75",
  "dateTime": "2019-08-28T08:34:15",
  "title": "product",
  "description": "an awesome product",
  "characteristic": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

• Get a page of pruducts // Страница товаров
  • GET: http://localhost:8000/api/product/{page}/{count}

curl -X GET "http://localhost:8000/api/product/0/5" -H "accept: application/json"

• Example Response Body

{
  "content": [
    {
      "id": "5d663c8786fc7828cc13bf75",
      "title": "product",
      "description": "an awesome product"
    },
    {
      "id": "5d6645dc86fc7828cc13bf76",
      "title": "book",
      "description": "a product 1"
    },
    {
      "id": "5d6645df86fc7828cc13bf77",
      "title": "phone",
      "description": "a product 2"
    },
    {
      "id": "5d6645e486fc7828cc13bf78",
      "title": "notebook",
      "description": "a product 3"
    },
    {
      "id": "5d6645ec86fc7828cc13bf79",
      "title": "magazine",
      "description": "a product 4"
    }
  ],
  "pageable": {
    "sort": {
      "sorted": false,
      "unsorted": true,
      "empty": true
    },
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 5,
    "paged": true,
    "unpaged": false
  },
  "last": false,
  "totalElements": 10,
  "totalPages": 2,
  "size": 5,
  "number": 0,
  "sort": {
    "sorted": false,
    "unsorted": true,
    "empty": true
  },
  "numberOfElements": 5,
  "first": true,
  "empty": false
}

• Get a page of pruducts filtered by product title // Страница товаров с фильтрацией по названию
  • POST: http://localhost:8000/api/product/{page}/{count}
  • Example Request Body stirng

curl -X POST "http://localhost:8000/api/product/0/5" -H "accept: application/json" -H "Content-Type: application/json" -d "book"

Example Response body

{
  "content": [
    {
      "id": "5d6645dc86fc7828cc13bf76",
      "title": "book",
      "description": "a product 1"
    },
    {
      "id": "5d6645e486fc7828cc13bf78",
      "title": "notebook",
      "description": "a product 3"
    },
    {
      "id": "5d6645ff86fc7828cc13bf7d",
      "title": "smartbook",
      "description": "a product 8"
    }
  ],
  "pageable": {
    "sort": {
      "sorted": false,
      "unsorted": true,
      "empty": true
    },
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 5,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalElements": 3,
  "totalPages": 1,
  "size": 5,
  "number": 0,
  "sort": {
    "sorted": false,
    "unsorted": true,
    "empty": true
  },
  "numberOfElements": 3,
  "first": true,
  "empty": false
}

• Get key book of pruduct characteristics
  • GET: http://localhost:8000/api/product/characteristic-key

curl -X GET "http://localhost:8000/api/product/characteristic-key" -H "accept: application/json"

• Example Response Body

[
  "key1",
  "key2",
  "key3"
]

• Get a list of products filtered by a key-value of the product characteristic // Список товаров с фильтрацией по параметру и его значению
  • POST: http://localhost:8000/api/product/characteristic-value
  • Example Request Body

{
  "string": {}
}

curl -X POST "http://localhost:8000/api/product/characteristic-value" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"key2\":\"42\"}"

• Example Response Body

[
  {
    "id": "5d6645ec86fc7828cc13bf79",
    "title": "magazine",
    "description": "a product 4"
  },
  {
    "id": "5d6645ef86fc7828cc13bf7a",
    "title": "smartphone",
    "description": "a product 5"
  }
]

• Get a list of all products
  • GET: http://localhost:8000/api/product

curl -X GET "http://localhost:8000/api/product" -H "accept: application/json"

• Example Response Body

[
  {
    "id": "5d663c8786fc7828cc13bf75",
    "title": "product",
    "description": "an awesome product"
  },
  {
    "id": "5d6645dc86fc7828cc13bf76",
    "title": "book",
    "description": "a product 1"
  },
  {
    "id": "5d6645df86fc7828cc13bf77",
    "title": "phone",
    "description": "a product 2"
  },
  {
    "id": "5d6645e486fc7828cc13bf78",
    "title": "notebook",
    "description": "a product 3"
  },
  {
    "id": "5d6645ec86fc7828cc13bf79",
    "title": "magazine",
    "description": "a product 4"
  },
  {
    "id": "5d6645ef86fc7828cc13bf7a",
    "title": "smartphone",
    "description": "a product 5"
  },
  {
    "id": "5d6645f386fc7828cc13bf7b",
    "title": "laptop",
    "description": "a product 6"
  },
  {
    "id": "5d6645fa86fc7828cc13bf7c",
    "title": "keyboard",
    "description": "a product 7"
  },
  {
    "id": "5d6645ff86fc7828cc13bf7d",
    "title": "smartbook",
    "description": "a product 8"
  },
  {
    "id": "5d66460886fc7828cc13bf7e",
    "title": "whiteboard",
    "description": "a product 9"
  }
]

• Get a list of filtered products
  • PATCH: http://localhost:8000/api/product
  • Example Request Body

{
  "characteristic": {
    "string": {}
  },
  "title": "string"
}

curl -X PATCH "http://localhost:8000/api/product" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"characteristic\": { \"key1\": \"23\" }, \"title\": \"phone\" }"

• Example Response Body

[
  {
    "id": "5d6645ef86fc7828cc13bf7a",
    "title": "smartphone",
    "description": "a product 5"
  }
]