新增学词章节

POST

/roadmap/chapter/add

新增学词章节

请求参数

Header 参数

payload

string

可选

默认值:

{'mid':{{mid}},'username':{{username}}}

Authorization

string

可选

默认值:

bearer {{access_token}}

Body 参数application/json

levelId

integer <int64>

关卡ID

可选

gradeId

integer <int64>

等级ID

可选

backImg

string

背景图片

可选

lang

array[string]

语言

可选

title

string

标题

可选

>= 1 字符<= 70 字符

tips

string

简介

可选

coverImg

string

可选

封面图片-默认取视频图片

words

array[string]

词库词ID

可选

version

enum<string>

可选

版本 1新版,0旧版

枚举值:

NOYESNE

video

integer <int64>

视频ID

可选

examples

string

可选

例句: 词库释义ID

duration

string

视频时长

可选

status

enum<string>

可选

1 可用, 0 不可用

枚举值:

FAILEDBLOCKENABLESHELVESUNBLOCKDISABLE

remark

string

备注

可选

studyWords

array[object (ChapterWordDTO) {25}]

v2 内容

可选

integer <int64>

可选

wordId

integer <int64>

词id

必需

chTitle

string

视频名称

可选

introduce

integer <int64>

视频介绍URI

可选

introduces

array[object (OptionsVO) {9}]

视频介绍下拉

可选

explainedType

enum<string>

可选

讲解类型 0 视频，1 图文

枚举值:

NOYESNE

explained

integer <int64>

讲解视频URI

可选

grammarImage

string

语法图片

可选

grammarContent

string

语法文本

可选

explains

array[object (OptionsVO) {9}]

讲解视频下拉框

可选

partTypes

array[object (OptionsVO) {9}]

词性下拉框

可选

remark

string

图文URI

可选

lang

string

语言

可选

status

enum<string>

可选

1 可用, 0 不可用

枚举值:

FAILEDBLOCKENABLESHELVESUNBLOCKDISABLE

wsort

integer

排序

可选

partType

integer <int64>

可选

词性ID, 对应词库释义ID

splitWord

array[object (WordItemDTO) {6}]

拆词

可选

types

array[string]

可选

拆词规则组[1,2]

mode

enum<string>

可选

是否随机 0 否, 1是

枚举值:

NOYESNE

type

enum<string>

可选

拆解规则，关联规则id - 拆解类型 0 不拆, 1 生母韵母, 2 按字拆

枚举值:

DEFARTWORD

wordVo

array[object (OptionsVO) {9}]

词组

可选

category

enum<string>

词条类型

可选

枚举值:

NOWORDSENTENCE

writeSwitch

enum<string>

可选

书写开关 1-开 0-关

枚举值:

NOYESNE

followSwitch

enum<string>

可选

跟读开关 1-开 0-关

枚举值:

NOYESNE

assemble

array[object (MapListString) {1}]

可选

选项和答案,多模式拆分规则

示例

{
    "levelId": 0,
    "gradeId": 0,
    "backImg": "string",
    "lang": [
        "string"
    ],
    "title": "string",
    "tips": "string",
    "coverImg": "string",
    "words": [
        "string"
    ],
    "version": "NO",
    "video": 0,
    "examples": "string",
    "duration": "string",
    "status": "FAILED",
    "remark": "string",
    "studyWords": [
        {
            "id": 0,
            "wordId": 0,
            "chTitle": "string",
            "introduce": 0,
            "introduces": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "explainedType": "NO",
            "explained": 0,
            "grammarImage": "string",
            "grammarContent": "string",
            "explains": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "partTypes": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "remark": "string",
            "lang": "string",
            "status": "FAILED",
            "wsort": 0,
            "partType": 0,
            "splitWord": [
                {
                    "type": "DEF",
                    "word": "string",
                    "spell": "string",
                    "audio": "string",
                    "sort": 0,
                    "splices": [
                        {}
                    ]
                }
            ],
            "types": [
                "string"
            ],
            "mode": "NO",
            "type": "DEF",
            "wordVo": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "category": "NO",
            "writeSwitch": "NO",
            "followSwitch": "NO",
            "assemble": [
                {
                    "key": [
                        "string"
                    ]
                }
            ]
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://test-apisix.taolihanyu.net/roadmap/chapter/add' \
--header 'payload: {'\''mid'\'':{{mid}},'\''username'\'':{{username}}}' \
--header 'Authorization: bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "levelId": 0,
    "gradeId": 0,
    "backImg": "string",
    "lang": [
        "string"
    ],
    "title": "string",
    "tips": "string",
    "coverImg": "string",
    "words": [
        "string"
    ],
    "version": "NO",
    "video": 0,
    "examples": "string",
    "duration": "string",
    "status": "FAILED",
    "remark": "string",
    "studyWords": [
        {
            "id": 0,
            "wordId": 0,
            "chTitle": "string",
            "introduce": 0,
            "introduces": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "explainedType": "NO",
            "explained": 0,
            "grammarImage": "string",
            "grammarContent": "string",
            "explains": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "partTypes": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "remark": "string",
            "lang": "string",
            "status": "FAILED",
            "wsort": 0,
            "partType": 0,
            "splitWord": [
                {
                    "type": "DEF",
                    "word": "string",
                    "spell": "string",
                    "audio": "string",
                    "sort": 0,
                    "splices": [
                        {}
                    ]
                }
            ],
            "types": [
                "string"
            ],
            "mode": "NO",
            "type": "DEF",
            "wordVo": [
                {
                    "dictValue": "string",
                    "dictLabel": "string",
                    "listClass": "default",
                    "tonePinyin": "string",
                    "numberPinyin": "string",
                    "other": "string",
                    "params": "string",
                    "category": "NO",
                    "type": 0
                }
            ],
            "category": "NO",
            "writeSwitch": "NO",
            "followSwitch": "NO",
            "assemble": [
                {
                    "key": [
                        "string"
                    ]
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

code

string

可选

data

integer

可选

msg

string

可选

total

integer

可选

示例

{
  "code": "",
  "data": 0,
  "msg": "",
  "total": 0
}

修改于 2025-06-20 03:31:02

学词章节详细信息

修改学词章节