1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/iim-JXCunOS

В этом репозитории не указан файл с открытой лицензией (LICENSE). При использовании обратитесь к конкретному описанию проекта и его зависимостям в коде.
Клонировать/Скачать
API_V2.md 11 КБ
Копировать Редактировать Web IDE Исходные данные Просмотреть построчно История
Отправлено 06.06.2025 15:35 e7a6498

Документация API для управления складом, продажами и закупками OS V2


Заголовок

key value
Content-Type application/json

1. Обновление типа (подтипа)

1. Метод: POST

2. Действие: type/updateTypeSon

3. Параметры:

param Обязательный Описание
typeId Да ID типа, который нужно изменить
typeFatherId Да ID большого типа (1 верхняя одежда, 2 брюки)
typeName Да Название типа
typeDescription Нет Описание типа (в базе данных используется перезапись, если ранее были заметки, то фронтенд должен передать комбинацию предыдущих и новых заметок в виде строки на бэкенд)
typeRemark Нет Заметки к типу (в базе данных используется перезапись, если ранее были заметки, то фронтенд должен передать комбинацию предыдущих и новых заметок в виде строки на бэкенд)

4. Пример:

  • URL: http://localhost:8082/jxcos/type/updateTypeSon
  • Параметры:
{
    "typeId":15,
    "typeFatherId":2,
    "typeName":"кожаная юбка",
    "typeDescription":"кожаная юбка",
    "typeRemark":"кожаная юбка"
}
  • Ответ:
{
    "status": 0,
    "msg": "Успешно",
    "data": null
}

2. Добавление типа (подтипа)

1. Метод: POST

2. Действие: type/addTypeSon

3. Параметры:

param Обязательный Описание
typeFatherId Да ID большого типа (1 верхняя одежда, 2 брюки)
typeName Да Название типа
typeDescription Нет Описание типа
typeRemark Нет Заметки к типу
  • URL: http://localhost:8082/jxcos/color/updateColor
  • Параметры:
{
    "colorId": 1,
    "colorName": "синий",
    "colorDescription": "темно-синий",
    "colorRemark": "используется для футболок"
}
  • Ответ:
{
    "status": 0,
    "msg": "Успешно",
    "data": {
        "colorId": 1,
        "colorName": "синий",
        "colorDescription": "темно-синий",
        "colorRemark": "используется для футболок"
    }
}

3. Обновление цвета

1. Метод: POST

2. Действие: color/updateColor

3. Параметры:

Параметр Обязательный Описание
colorId Да ID цвета
colorName Да Название цвета
colorDescription Нет Описание цвета
colorRemark Нет Заметки по цвету

4. Пример:

  • URL: http://localhost:8082/jxcos/color/updateColor
  • Параметры:``` { "colorId": 10, "colorName": "Без цвета прозрачный", "colorDescription": "Императорская одежда", "colorRemark": "Императорская одежда" }

+ Ответ:

{ "status": 0, "msg": "Успешно", "data": null }


---

### 5. Добавление цвета
#### 1. Метод: `POST`
#### 2. Действие: `color/addColor`
#### 3. Параметры:

|Параметр           |Обязательный   |Описание     |
|-------------       |-----          |-------      |
|colorName           |Y              |Название цвета |
|colorDescription    |N              |Описание цвета |
|colorRemark         |N              |Заметки по цвету |

#### 4. Пример:
+ URL: `http://localhost:8082/jxcos/color/addColor`
+ Параметры:

{ "colorName": "Без цвета", "colorDescription": "Такова моя воля", "colorRemark": "Такова моя воля" }


+ Ответ:

{ "status": 0, "msg": "Успешно", "data": { "colorId": 10, "colorName": "Без цвета", "colorDescription": "Такова моя воля", "colorRemark": "Такова моя воля" } }


---

### 6. Обновление материала
#### 1. Метод: `POST`
#### 2. Действие: `material/updateMaterial`
#### 3. Параметры:

|Параметр           |Обязательный   |Описание     |
|-------------       |-----          |-------      |
|materialId          |Y              |ID материала |
|materialName        |Y              |Название материала |
|materialDescription |N              |Описание материала (в базе данных используется перезапись, если ранее были заметки, то необходимо передать их вместе с новыми заметками в виде конкатенации на сервер) |
|materialRemark      |N              |Заметки по материалу (в базе данных используется перезапись, если ранее были заметки, то необходимо передать их вместе с новыми заметками в виде конкатенации на сервер) |
#### 4. Пример:
+ URL: `http://localhost:8082/jxcos/material/updateMaterial`
+ Параметры:

{ "materialId": 9, "materialName": "Барсучий и лисий мех", "materialDescription": "Такова моя воля", "materialRemark": "Такова моя воля" }


+ Ответ:

{ "status": 0, "msg": "Успешно", "data": null }


---

### 7. Добавление материала
#### 1. Метод: `POST`
#### 2. Действие: `material/addMaterial`
#### 3. Параметры:

|Параметр           |Обязательный   |Описание     |
|-------------       |-----          |-------      |
|materialName        |Y              |Название материала |
|materialDescription |N              |Описание материала |
|materialRemark      |N              |Заметки по материалу |

#### 4. Демонстрация:
+ URL: `http://localhost:8082/jxcos/material/addMaterial`
+ Параметры:

{ "materialName": "/Dk", "materialDescription": "Такова наша воля", "materialRemark": "Такова наша воля" }


+ Ответ:

{ "status": 0, "msg": "Успешно", "data": { "materialId": 9, "materialName": "/Dk", "materialDescription": "Такова наша воля", "materialRemark": "Такова наша воля" } }


---

### 7. Обновление размера
#### 1. Метод: `POST`
#### 2. Действие: `size/updateSize`
#### 3. Параметры:|параметр           |Обязательный   |Описание     |
|-------------   |----- |------- |
|sizeId          |Да     |ID размера для обновления |
|typeFatherId    |Да     |ID большого типа (1 верхняя одежда, 2 брюки) |
|sizeName        |Да     |Название размера |
|sizeDescription |Нет     |Описание размера (в базе данных используется ***перезапись***, если ранее были заметки, то фронтенд должен передать объединённые старые и новые заметки ***в одном поле*** на бэкенд) |
|sizeRemark      |Нет     |Заметки к размеру (в базе данных используется ***перезапись***, если ранее были заметки, то фронтенд должен передать объединённые старые и новые заметки ***в одном поле*** на бэкенд) |#### 4. демонстрация:
+ URL: `http://localhost:8082/jxcos/size/updateSize`
+ параметры:

{ "sizeId": 2, "typeFatherId": 2, "sizeName": "2 размер 1?", "sizeDescription": "Узкая талия?", "sizeRemark": "Узкая талия?" }


+ ответ:

{ "status": 0, "msg": "Успешно", "data": null }


---

### 8. Добавление размера
#### 1. метод: `POST`
#### 2. действие: `size/addSize`
#### 3. параметры:

|параметр           |Обязательный   |Описание     |
|-------------   |----- |------- |
|typeFatherId    |Да     |ID большого типа (1 верхняя одежда, 2 брюки) |
|sizeName        |Да     |Название размера |
|sizeDescription |Нет     |Описание размера |
|sizeRemark      |Нет     |Заметки к размеру |

#### 4. демонстрация:
+ URL: `http://localhost:8082/jxcos/size/addSize`
+ параметры:

{ "typeFatherId": 2, "sizeName": "2 размер 1", "sizeDescription": "Узкая талия", "sizeRemark": "Узкая талия" }


+ ответ:

{ "status": 0, "msg": "Успешно", "data": { "sizeId": 2, "typeFatherId": 2, "sizeName": "2 размер 1", "sizeDescription": "Узкая талия", "sizeRemark": "Узкая талия" } }


---

### 4. Демонстрация:
+ URL: `http://localhost:8082/jxcos/size/updateSize`
+ параметры:

{ "sizeId": 2, "typeFatherId": 2, "sizeName": "2 размер 1?", "sizeDescription": "Узкая талия?", "sizeRemark": "Узкая талия?" }


+ Ответ:

{ "status": 0, "msg": "Успешно", "data": null }


---

### 8. Добавление размера
#### 1. Метод: `POST`
#### 2. Действие: `size/addSize`
#### 3. Параметры:

|Параметр           |Обязательный   |Описание     |
|-------------   |----- |------- |
|typeFatherId    |Да     |ID большого типа (1 верхняя одежда, 2 брюки) |
|sizeName        |Да     |Название размера |
|sizeDescription |Нет     |Описание размера |
|sizeRemark      |Нет     |Заметки к размеру |

#### 4. Демонстрация:
+ URL: `http://localhost:8082/jxcos/size/addSize`
+ Параметры:

{ "typeFatherId": 2, "sizeName": "2 размер 1", "sizeDescription": "Узкая талия", "sizeRemark": "Узкая талия" }


+ Ответ:

{ "status": 0, "msg": "Успешно", "data": { "sizeId": 2, "typeFatherId": 2, "sizeName": "2 размер 1", "sizeDescription": "Узкая талия", "sizeRemark": "Узкая талия" } }


Опубликовать ( 0 )

Вы можете оставить комментарий после Вход в систему

1
https://api.gitlife.ru/oschina-mirror/iim-JXCunOS.git
git@api.gitlife.ru:oschina-mirror/iim-JXCunOS.git
oschina-mirror
iim-JXCunOS
iim-JXCunOS
master