From 25345ae006d382adce35c176f3d9698110a9fa91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=BB=84=E6=B5=B7?= <10402852@qq.com> Date: Tue, 15 Oct 2024 13:11:25 +0800 Subject: [PATCH] 'commit' --- dsRes/Doc/v1.0/.cache.json | 2 +- ...source_Base_Controller_BaseController.html | 567 ++++++++++++++++++ dsRes/Doc/v1.0/dsProject-v1.0-api-docs.json | 290 +++++++++ dsRes/Doc/v1.0/dsRes-v1.0-api-docs.json | 9 - dsRes/Doc/v1.0/index.html | 57 +- .../Base/Controller/BaseController.java | 21 +- .../dsideal/resource/JApiDocsGenerator.java | 2 +- 7 files changed, 925 insertions(+), 23 deletions(-) create mode 100644 dsRes/Doc/v1.0/com_dsideal_resource_Base_Controller_BaseController.html create mode 100644 dsRes/Doc/v1.0/dsProject-v1.0-api-docs.json delete mode 100644 dsRes/Doc/v1.0/dsRes-v1.0-api-docs.json diff --git a/dsRes/Doc/v1.0/.cache.json b/dsRes/Doc/v1.0/.cache.json index 0637a088..3c66ba24 100644 --- a/dsRes/Doc/v1.0/.cache.json +++ b/dsRes/Doc/v1.0/.cache.json @@ -1 +1 @@ -[] \ No newline at end of file +[{"baseUrl":"","className":"BaseController","description":"BaseController","docFileName":"com_dsideal_resource_Base_Controller_BaseController.html","generateDocs":true,"packageName":"com.dsideal.resource.Base.Controller","requestNodes":[{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#getStageList","deprecated":false,"description":"获取学段列表","header":[],"method":["GET","POST"],"methodName":"getStageList","paramNodes":[],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/getStageList"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#addSubject","deprecated":false,"description":"增加科目","header":[],"method":["GET","POST"],"methodName":"addSubject","paramNodes":[{"description":"科目名称","jsonBody":false,"name":"subject_name","required":false,"type":"string"},{"description":"科目代码","jsonBody":false,"name":"subject_code","required":false,"type":"string"},{"description":"学段ID","jsonBody":false,"name":"stage_id","required":false,"type":"int"},{"description":"排序号","jsonBody":false,"name":"sort_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/addSubject"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#delSubject","deprecated":false,"description":"删除科目","header":[],"method":["GET","POST"],"methodName":"delSubject","paramNodes":[{"description":"科目ID","jsonBody":false,"name":"subject_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/delSubject"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#updateSubject","deprecated":false,"description":"修改科目","header":[],"method":["GET","POST"],"methodName":"updateSubject","paramNodes":[{"description":"科目ID","jsonBody":false,"name":"subject_id","required":false,"type":"int"},{"description":"科目名称","jsonBody":false,"name":"subject_name","required":false,"type":"string"},{"description":"科目代码","jsonBody":false,"name":"subject_code","required":false,"type":"string"},{"description":"学段ID","jsonBody":false,"name":"stage_id","required":false,"type":"int"},{"description":"排序号","jsonBody":false,"name":"sort_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/updateSubject"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#listSubject","deprecated":false,"description":"科目列表","header":[],"method":["GET","POST"],"methodName":"listSubject","paramNodes":[{"description":"学段id","jsonBody":false,"name":"stage_id","required":false,"type":"int"},{"description":"页码","jsonBody":false,"name":"pageNum","required":false,"type":"int"},{"description":"每页大小","jsonBody":false,"name":"pageSize","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/listSubject"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#getSubject","deprecated":false,"description":"获取科目详情","header":[],"method":["GET","POST"],"methodName":"getSubject","paramNodes":[{"description":"科目ID","jsonBody":false,"name":"subject_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/getSubject"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#addScheme","deprecated":false,"description":"增加版本","header":[],"method":["GET","POST"],"methodName":"addScheme","paramNodes":[{"description":"版本名称","jsonBody":false,"name":"scheme_name","required":false,"type":"string"},{"description":"学段ID","jsonBody":false,"name":"stage_id","required":false,"type":"int"},{"description":"科目ID","jsonBody":false,"name":"subject_id","required":false,"type":"int"},{"description":"创建人ID","jsonBody":false,"name":"owner_id","required":false,"type":"string"},{"description":"1:章节目录结构 2:知识点结构","jsonBody":false,"name":"type_id","required":false,"type":"int"},{"description":"1:系统 2云盘","jsonBody":false,"name":"scheme_type_id","required":false,"type":"int"},{"description":"排序号","jsonBody":false,"name":"sort_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/addScheme"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#delScheme","deprecated":false,"description":"删除版本","header":[],"method":["GET","POST"],"methodName":"delScheme","paramNodes":[{"description":"版本ID","jsonBody":false,"name":"scheme_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/delScheme"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#updateScheme","deprecated":false,"description":"修改版本","header":[],"method":["GET","POST"],"methodName":"updateScheme","paramNodes":[{"description":"版本ID","jsonBody":false,"name":"scheme_id","required":false,"type":"int"},{"description":"版本名称","jsonBody":false,"name":"scheme_name","required":false,"type":"string"},{"description":"学段ID","jsonBody":false,"name":"stage_id","required":false,"type":"int"},{"description":"科目ID","jsonBody":false,"name":"subject_id","required":false,"type":"int"},{"description":"1:章节目录结构 2:知识点结构","jsonBody":false,"name":"type_id","required":false,"type":"int"},{"description":"1:系统 2云盘","jsonBody":false,"name":"scheme_type_id","required":false,"type":"int"},{"description":"排序号","jsonBody":false,"name":"sort_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/updateScheme"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#listScheme","deprecated":false,"description":"版本列表","header":[],"method":["GET","POST"],"methodName":"listScheme","paramNodes":[{"description":"学段ID","jsonBody":false,"name":"stage_id","required":false,"type":"int"},{"description":"页码","jsonBody":false,"name":"pageNum","required":false,"type":"int"},{"description":"每页大小","jsonBody":false,"name":"pageSize","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/listScheme"},{"changeFlag":0,"codeFileUrl":"com_dsideal_resource_Base_Controller_BaseController.html#getScheme","deprecated":false,"description":"获取版本信息","header":[],"method":["GET","POST"],"methodName":"getScheme","paramNodes":[{"description":"版本ID","jsonBody":false,"name":"scheme_id","required":false,"type":"int"}],"responseNode":{"childNodes":[],"className":"","list":false,"showFieldNotNull":false},"url":"/base/getScheme"}],"srcFileName":"D:\\dsWork\\dsProject\\dsRes\\src\\main\\java\\com\\dsideal\\resource\\Base\\Controller\\BaseController.java"}] \ No newline at end of file diff --git a/dsRes/Doc/v1.0/com_dsideal_resource_Base_Controller_BaseController.html b/dsRes/Doc/v1.0/com_dsideal_resource_Base_Controller_BaseController.html new file mode 100644 index 00000000..0d541546 --- /dev/null +++ b/dsRes/Doc/v1.0/com_dsideal_resource_Base_Controller_BaseController.html @@ -0,0 +1,567 @@ + + + + + + BaseController + + + + + + + +
+
+ +
+
+
+
+
+ 目录 +
+
+
+
+
+
+

获取学段列表

+

请求URL

+

+ /base/getStageList + GET + POST +

+

返回结果

+
{}
+
+
+
+

增加科目

+

请求URL

+

+ /base/addSubject + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型必须描述
subject_namestring科目名称
subject_codestring科目代码
stage_idint学段ID
sort_idint排序号
+

返回结果

+
{}
+
+
+
+

删除科目

+

请求URL

+

+ /base/delSubject + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + +
参数名类型必须描述
subject_idint科目ID
+

返回结果

+
{}
+
+
+
+

修改科目

+

请求URL

+

+ /base/updateSubject + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型必须描述
subject_idint科目ID
subject_namestring科目名称
subject_codestring科目代码
stage_idint学段ID
sort_idint排序号
+

返回结果

+
{}
+
+
+
+

科目列表

+

请求URL

+

+ /base/listSubject + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型必须描述
stage_idint学段id
pageNumint页码
pageSizeint每页大小
+

返回结果

+
{}
+
+
+
+

获取科目详情

+

请求URL

+

+ /base/getSubject + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + +
参数名类型必须描述
subject_idint科目ID
+

返回结果

+
{}
+
+
+
+

增加版本

+

请求URL

+

+ /base/addScheme + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型必须描述
scheme_namestring版本名称
stage_idint学段ID
subject_idint科目ID
owner_idstring创建人ID
type_idint1:章节目录结构 2:知识点结构
scheme_type_idint1:系统 2云盘
sort_idint排序号
+

返回结果

+
{}
+
+
+
+

删除版本

+

请求URL

+

+ /base/delScheme + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + +
参数名类型必须描述
scheme_idint版本ID
+

返回结果

+
{}
+
+
+
+

修改版本

+

请求URL

+

+ /base/updateScheme + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型必须描述
scheme_idint版本ID
scheme_namestring版本名称
stage_idint学段ID
subject_idint科目ID
type_idint1:章节目录结构 2:知识点结构
scheme_type_idint1:系统 2云盘
sort_idint排序号
+

返回结果

+
{}
+
+
+
+

版本列表

+

请求URL

+

+ /base/listScheme + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + + + + + + + + + + + + + +
参数名类型必须描述
stage_idint学段ID
pageNumint页码
pageSizeint每页大小
+

返回结果

+
{}
+
+
+
+

获取版本信息

+

请求URL

+

+ /base/getScheme + GET + POST +

+

请求参数 application/x-www-form-urlencoded

+ + + + + + + + + + + + + +
参数名类型必须描述
scheme_idint版本ID
+

返回结果

+
{}
+
+
+
+
+
+
+
+
+ + + + + + + \ No newline at end of file diff --git a/dsRes/Doc/v1.0/dsProject-v1.0-api-docs.json b/dsRes/Doc/v1.0/dsProject-v1.0-api-docs.json new file mode 100644 index 00000000..c8041cb7 --- /dev/null +++ b/dsRes/Doc/v1.0/dsProject-v1.0-api-docs.json @@ -0,0 +1,290 @@ +{ + "item": [ + { + "request": { + "method": "GET", + "url": { + "query": [], + "raw": "{{domain}}/base/getStageList" + } + }, + "name": "获取学段列表" + }, + { + "request": { + "method": "POST", + "url": { + "query": [ + { + "description": "科目名称", + "value": "", + "key": "subject_name" + }, + { + "description": "科目代码", + "value": "", + "key": "subject_code" + }, + { + "description": "学段ID", + "value": "", + "key": "stage_id" + }, + { + "description": "排序号", + "value": "", + "key": "sort_id" + } + ], + "raw": "{{domain}}/base/addSubject" + } + }, + "name": "增加科目" + }, + { + "request": { + "method": "POST", + "url": { + "query": [ + { + "description": "科目ID", + "value": "", + "key": "subject_id" + } + ], + "raw": "{{domain}}/base/delSubject" + } + }, + "name": "删除科目" + }, + { + "request": { + "method": "POST", + "url": { + "query": [ + { + "description": "科目ID", + "value": "", + "key": "subject_id" + }, + { + "description": "科目名称", + "value": "", + "key": "subject_name" + }, + { + "description": "科目代码", + "value": "", + "key": "subject_code" + }, + { + "description": "学段ID", + "value": "", + "key": "stage_id" + }, + { + "description": "排序号", + "value": "", + "key": "sort_id" + } + ], + "raw": "{{domain}}/base/updateSubject" + } + }, + "name": "修改科目" + }, + { + "request": { + "method": "GET", + "url": { + "query": [ + { + "description": "学段id", + "value": "", + "key": "stage_id" + }, + { + "description": "页码", + "value": "", + "key": "pageNum" + }, + { + "description": "每页大小", + "value": "", + "key": "pageSize" + } + ], + "raw": "{{domain}}/base/listSubject" + } + }, + "name": "科目列表" + }, + { + "request": { + "method": "GET", + "url": { + "query": [ + { + "description": "科目ID", + "value": "", + "key": "subject_id" + } + ], + "raw": "{{domain}}/base/getSubject" + } + }, + "name": "获取科目详情" + }, + { + "request": { + "method": "POST", + "url": { + "query": [ + { + "description": "版本名称", + "value": "", + "key": "scheme_name" + }, + { + "description": "学段ID", + "value": "", + "key": "stage_id" + }, + { + "description": "科目ID", + "value": "", + "key": "subject_id" + }, + { + "description": "创建人ID", + "value": "", + "key": "owner_id" + }, + { + "description": "1:章节目录结构 2:知识点结构", + "value": "", + "key": "type_id" + }, + { + "description": "1:系统 2云盘", + "value": "", + "key": "scheme_type_id" + }, + { + "description": "排序号", + "value": "", + "key": "sort_id" + } + ], + "raw": "{{domain}}/base/addScheme" + } + }, + "name": "增加版本" + }, + { + "request": { + "method": "POST", + "url": { + "query": [ + { + "description": "版本ID", + "value": "", + "key": "scheme_id" + } + ], + "raw": "{{domain}}/base/delScheme" + } + }, + "name": "删除版本" + }, + { + "request": { + "method": "POST", + "url": { + "query": [ + { + "description": "版本ID", + "value": "", + "key": "scheme_id" + }, + { + "description": "版本名称", + "value": "", + "key": "scheme_name" + }, + { + "description": "学段ID", + "value": "", + "key": "stage_id" + }, + { + "description": "科目ID", + "value": "", + "key": "subject_id" + }, + { + "description": "1:章节目录结构 2:知识点结构", + "value": "", + "key": "type_id" + }, + { + "description": "1:系统 2云盘", + "value": "", + "key": "scheme_type_id" + }, + { + "description": "排序号", + "value": "", + "key": "sort_id" + } + ], + "raw": "{{domain}}/base/updateScheme" + } + }, + "name": "修改版本" + }, + { + "request": { + "method": "GET", + "url": { + "query": [ + { + "description": "学段ID", + "value": "", + "key": "stage_id" + }, + { + "description": "页码", + "value": "", + "key": "pageNum" + }, + { + "description": "每页大小", + "value": "", + "key": "pageSize" + } + ], + "raw": "{{domain}}/base/listScheme" + } + }, + "name": "版本列表" + }, + { + "request": { + "method": "GET", + "url": { + "query": [ + { + "description": "版本ID", + "value": "", + "key": "scheme_id" + } + ], + "raw": "{{domain}}/base/getScheme" + } + }, + "name": "获取版本信息" + } + ], + "name": "BaseController" +} \ No newline at end of file diff --git a/dsRes/Doc/v1.0/dsRes-v1.0-api-docs.json b/dsRes/Doc/v1.0/dsRes-v1.0-api-docs.json deleted file mode 100644 index 1074fd13..00000000 --- a/dsRes/Doc/v1.0/dsRes-v1.0-api-docs.json +++ /dev/null @@ -1,9 +0,0 @@ -{ -"info": { -"_postman_id": "", -"name": "dsRes", -"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" -}, -"item": [ -] -} \ No newline at end of file diff --git a/dsRes/Doc/v1.0/index.html b/dsRes/Doc/v1.0/index.html index 98d917a6..ab6a4291 100644 --- a/dsRes/Doc/v1.0/index.html +++ b/dsRes/Doc/v1.0/index.html @@ -3,7 +3,7 @@ - dsResAPI Documentation + dsProjectAPI Documentation @@ -14,7 +14,7 @@
+
@@ -51,6 +92,7 @@

本文档由JApiDocs生成

@@ -65,6 +107,17 @@