File size: 40,565 Bytes
e657e99 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 | openapi: 3.0.3
info:
title: RamEx 拉曼光谱分析系统 API
description: |
RamEx（Raman Expression Analysis）是一个专业的拉曼光谱数据分析平台API。
## 认证方式
所有API接口（除了Token验证接口）都需要提供有效的Token进行认证。
Token可以通过以下三种方式传递：
1. **Authorization Header**: `Authorization: Token <your_token>`
2. **URL参数**: `?token=<your_token>`
3. **JSON数据**: `{"token": "<your_token>"}`
## 工作流程
1. 使用第三方Token验证身份
2. 创建项目
3. 上传拉曼光谱数据（ZIP格式）
4. 确认分组信息
5. 执行数据预处理
6. 进行无元数据分析或基于元数据分析
7. 查看和导出结果
version: 1.0.0
contact:
email: support@ramex.com
license:
name: BSD License
servers:
- url: http://localhost:8000/api
description: 本地开发服务器
- url: http://your-domain.com/api
description: 生产服务器
tags:
- name: 认证
description: Token验证和用户信息接口
- name: 项目管理
description: 项目的创建、查询、更新和删除
- name: 数据管理
description: 数据文件的上传、选择、更新和删除
- name: 数据预处理
description: 拉曼光谱数据预处理功能
- name: 无元数据分析
description: 不依赖外部元数据的分析方法
- name: 基于元数据分析
description: 基于元数据的高级分析方法
- name: 结果管理
description: 分析结果的查看和导出
components:
securitySchemes:
TokenAuth:
type: apiKey
in: header
name: Authorization
description: 'Token认证，格式: Token <your_token>'
schemas:
Error:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: 错误代码
message:
type: string
description: 错误信息
required:
- error
Project:
type: object
properties:
id:
type: string
format: uuid
description: 项目唯一标识符
example: "7fb9352d-1797-4d8d-bed7-cc388352f65c"
name:
type: string
description: 项目名称
example: "酵母拉曼光谱分析"
description:
type: string
description: 项目描述
example: "酵母细胞在不同时间点的拉曼光谱数据分析"
created_at:
type: string
format: date-time
description: 创建时间
last_modified:
type: string
format: date-time
description: 最后修改时间
status:
type: string
enum:
- initialized
- data_loaded
- preprocessing
- preprocessing_completed
- analysis
- completed
- error
description: |
项目状态:
- initialized: 已初始化
- data_loaded: 数据已加载
- preprocessing: 数据预处理中
- preprocessing_completed: 数据预处理完成
- analysis: 分析中
- completed: 已完成
- error: 出错
required:
- name
ProjectDetail:
allOf:
- $ref: '#/components/schemas/Project'
- type: object
properties:
data_files:
type: array
items:
$ref: '#/components/schemas/DataFile'
description: 项目的所有数据文件
active_data_file:
$ref: '#/components/schemas/DataFile'
description: 当前活动的数据文件
data_files_count:
type: integer
description: 数据文件总数
DataFile:
type: object
properties:
id:
type: integer
description: 文件ID
filename:
type: string
description: 文件名
example: "yeast_data.zip"
uploaded_at:
type: string
format: date-time
description: 上传时间
wavenumber_min:
type: number
format: float
description: 最小波数 (cm⁻¹)
example: 500.0
wavenumber_max:
type: number
format: float
description: 最大波数 (cm⁻¹)
example: 3150.0
group_index:
type: integer
description: 分组索引（文件名中用于分组的部分位置）
example: 2
TokenValidationResponse:
type: object
properties:
valid:
type: boolean
description: Token是否有效
message:
type: string
description: 验证消息
user_info:
type: object
properties:
third_party_username:
type: string
description: 第三方用户名
local_user_exists:
type: boolean
description: 本地用户是否已存在
local_username:
type: string
description: 本地用户名
local_user_id:
type: integer
description: 本地用户ID
token_info:
type: object
properties:
token_preview:
type: string
description: Token预览
token_length:
type: integer
description: Token长度
UserInfo:
type: object
properties:
user_info:
type: object
properties:
local_user_id:
type: integer
description: 本地用户ID
local_username:
type: string
description: 本地用户名
email:
type: string
description: 邮箱
date_joined:
type: string
format: date-time
description: 注册时间
last_login:
type: string
format: date-time
description: 最后登录时间
third_party_info:
type: object
properties:
third_party_user_id:
type: integer
description: 第三方用户ID
third_party_username:
type: string
description: 第三方用户名
created_at:
type: string
format: date-time
description: 映射创建时间
statistics:
type: object
properties:
projects_count:
type: integer
description: 项目总数
data_directories:
type: object
properties:
user_base_dir:
type: string
description: 用户基础目录
projects_dir:
type: string
description: 项目目录
paths:
/token/validate/:
post:
tags:
- 认证
summary: 验证Token
description: |
验证Token的有效性并获取用户信息。
此接口不需要认证，用于首次验证Token。
operationId: validateToken
security: []
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: 要验证的Token
example: "0c47b3d5b1aa561a5032f50e95bf069afa9a9e55"
application/x-www-form-urlencoded:
schema:
type: object
properties:
token:
type: string
parameters:
- name: token
in: query
description: Token（也可以通过URL参数传递）
schema:
type: string
responses:
'200':
description: Token验证成功
content:
application/json:
schema:
$ref: '#/components/schemas/TokenValidationResponse'
'400':
description: Token参数缺失
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'401':
description: Token无效或已过期
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
tags:
- 认证
summary: 验证Token（GET方式）
description: 通过GET方法验证Token，Token通过URL参数传递
operationId: validateTokenGet
security: []
parameters:
- name: token
in: query
required: true
description: 要验证的Token
schema:
type: string
responses:
'200':
description: Token验证成功
content:
application/json:
schema:
$ref: '#/components/schemas/TokenValidationResponse'
'400':
description: Token参数缺失
'401':
description: Token无效
/user/info/:
get:
tags:
- 认证
summary: 获取当前用户信息
description: 获取已认证用户的详细信息，包括本地用户信息、第三方映射信息和统计数据
operationId: getUserInfo
security:
- TokenAuth: []
responses:
'200':
description: 成功获取用户信息
content:
application/json:
schema:
$ref: '#/components/schemas/UserInfo'
'401':
description: 用户未认证
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/projects/:
get:
tags:
- 项目管理
summary: 获取项目列表
description: 获取当前用户的所有项目列表
operationId: listProjects
security:
- TokenAuth: []
responses:
'200':
description: 成功获取项目列表
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Project'
'401':
description: 未授权
post:
tags:
- 项目管理
summary: 创建新项目
description: 创建一个新的拉曼光谱分析项目
operationId: createProject
security:
- TokenAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 项目名称
example: "酵母拉曼光谱分析"
description:
type: string
description: 项目描述
example: "酵母细胞在不同时间点的拉曼光谱数据分析"
required:
- name
responses:
'201':
description: 项目创建成功
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Project'
- type: object
properties:
next_steps:
type: array
items:
type: object
properties:
step:
type: string
url:
type: string
description:
type: string
'400':
description: 请求参数错误
'401':
description: 未授权
/projects/{project_id}/:
get:
tags:
- 项目管理
summary: 获取项目详情
description: 获取指定项目的详细信息，包括所有数据文件
operationId: getProject
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
description: 项目UUID
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取项目详情
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectDetail'
'404':
description: 项目不存在
put:
tags:
- 项目管理
summary: 更新项目（完整更新）
description: 完整更新项目信息
operationId: updateProject
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
responses:
'200':
description: 更新成功
content:
application/json:
schema:
$ref: '#/components/schemas/Project'
'404':
description: 项目不存在
patch:
tags:
- 项目管理
summary: 更新项目（部分更新）
description: 部分更新项目信息
operationId: partialUpdateProject
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
description:
type: string
responses:
'200':
description: 更新成功
'404':
description: 项目不存在
delete:
tags:
- 项目管理
summary: 删除项目
description: 删除项目及其所有关联的数据文件
operationId: deleteProject
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: 删除成功
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "success"
message:
type: string
example: "项目已成功删除"
'404':
description: 项目不存在
'500':
description: 删除文件时出错
/projects/{project_id}/data/upload/:
post:
tags:
- 数据管理
summary: 上传数据文件
description: |
上传拉曼光谱数据文件（ZIP格式）。
ZIP文件应包含多个.txt格式的拉曼光谱数据文件。
operationId: uploadData
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
files:
type: string
format: binary
description: ZIP格式的数据文件
group_index:
type: integer
description: 分组索引（文件名中用于分组的部分位置，按下划线分隔）
default: 2
example: 2
Wavenumber range:
type: string
description: 波数范围，格式为"最小值,最大值"
example: "500,3150"
required:
- files
responses:
'200':
description: 上传成功
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: "success"
group_names:
type: array
items:
type: string
description: 检测到的分组名称
example: ["Control", "Treatment"]
next_steps:
type: array
items:
type: object
message:
type: string
'400':
description: 请求参数错误
'404':
description: 项目不存在
'500':
description: 处理文件时出错
/projects/{project_id}/data/group_info/:
get:
tags:
- 数据管理
summary: 获取分组信息
description: 获取当前活动数据文件的分组信息
operationId: getGroupInfo
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取分组信息
content:
application/json:
schema:
type: object
properties:
status:
type: string
group_names:
type: array
items:
type: string
'400':
description: 项目没有活动数据文件
'404':
description: 项目不存在
/projects/{project_id}/data/save_rds/:
post:
tags:
- 数据管理
summary: 保存确认的RDS数据
description: 确认分组信息并保存RDS数据文件
operationId: saveRdsData
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: object
properties:
group_order:
type: array
items:
type: string
description: 分组顺序（可选）
example: ["Control", "Treatment"]
responses:
'200':
description: 保存成功
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
next_url:
type: string
'400':
description: 项目没有活动数据文件
'404':
description: 项目不存在
/projects/{project_id}/data/{file_id}/select/:
post:
tags:
- 数据管理
summary: 选择活动数据文件
description: 将指定的数据文件设置为当前活动文件
operationId: selectDataFile
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
- name: file_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: 设置成功
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
active_file:
$ref: '#/components/schemas/DataFile'
'404':
description: 项目或文件不存在
/projects/{project_id}/data/{file_id}/update/:
post:
tags:
- 数据管理
summary: 更新数据文件
description: 更新数据文件的波数范围
operationId: updateDataFile
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
- name: file_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
type: object
properties:
wavenumber_range:
type: string
description: 波数范围，格式为"最小值,最大值"
example: "500,3150"
responses:
'200':
description: 更新成功
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
data_file:
$ref: '#/components/schemas/DataFile'
'400':
description: 波数范围格式无效
'404':
description: 项目或文件不存在
/projects/{project_id}/data/{file_id}/delete/:
delete:
tags:
- 数据管理
summary: 删除数据文件
description: 删除指定的数据文件
operationId: deleteDataFile
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
- name: file_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: 删除成功
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
'404':
description: 项目或文件不存在
/projects/{project_id}/preprocessing/status/:
get:
tags:
- 数据预处理
summary: 获取预处理状态
description: 获取项目的最新预处理任务状态
operationId: getPreprocessingStatus
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取状态
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum: [not_started, processing, completed, error]
parameters:
type: object
description: 预处理参数
result:
type: object
description: 预处理结果
'404':
description: 项目不存在
/projects/{project_id}/preprocessing/:
post:
tags:
- 数据预处理
summary: 执行数据预处理
description: |
对拉曼光谱数据执行预处理操作。
预处理包括：
- 质量控制（异常值检测）
- 峰值去除（宇宙射线）
- 平滑处理
- 标准化
- 基线校正
operationId: runPreprocessing
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
quality_control:
type: object
description: 质量控制参数
properties:
euclidean_distance:
type: object
properties:
enabled:
type: boolean
max_distance:
type: number
snr:
type: object
properties:
enabled:
type: boolean
strictness:
type: string
enum: [low, medium, high]
spike_removal:
type: object
description: 峰值去除参数
properties:
enabled:
type: boolean
intensity:
type: number
smoothing:
type: object
description: 平滑处理参数
properties:
method:
type: string
enum: [savitzky_golay, whittaker, moving_average]
window_size:
type: integer
normalization:
type: object
description: 标准化参数
properties:
method:
type: string
enum: [minmax, zscore, vector, area]
baseline_correction:
type: object
description: 基线校正参数
properties:
method:
type: string
enum: [polynomial, als]
degree:
type: integer
responses:
'200':
description: 预处理完成
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
plot_url:
type: string
description: 预处理结果图表URL
result:
type: object
'400':
description: 项目状态不适合进行预处理
'404':
description: 项目不存在
'500':
description: 预处理执行失败
/projects/{project_id}/preprocessing/export/:
get:
tags:
- 数据预处理
summary: 导出预处理数据
description: 下载预处理后的RDS数据文件
operationId: exportPreprocessing
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 文件下载
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: 项目或文件不存在
/projects/{project_id}/meta-free/status/:
get:
tags:
- 无元数据分析
summary: 获取无元数据分析状态
description: 获取项目的最新无元数据分析任务状态
operationId: getMetaFreeStatus
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取状态
'404':
description: 项目不存在
/projects/{project_id}/meta-free/:
post:
tags:
- 无元数据分析
summary: 执行无元数据分析
description: |
执行不依赖外部元数据的分析方法。
支持的分析方法：
- 降维分析（PCA、LDA、ICA）
- 聚类分析（K-means、层次聚类）
- 多维度尺度分析（MDS）
- 光谱分解（NMF）
- 峰值检测和分析
operationId: runMetaFreeAnalysis
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
analysis_methods:
type: array
items:
type: string
enum: [pca, lda, ica, kmeans, hierarchical, mds, nmf, peak_detection]
description: 要执行的分析方法列表
parameters:
type: object
description: 各分析方法的参数
properties:
pca:
type: object
properties:
n_components:
type: integer
description: 主成分数量
lda:
type: object
properties:
n_components:
type: integer
kmeans:
type: object
properties:
n_clusters:
type: integer
description: 聚类数量
responses:
'200':
description: 分析完成
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
result:
type: object
'400':
description: 项目状态不适合进行分析
'404':
description: 项目不存在
'500':
description: 分析执行失败
/projects/{project_id}/meta-free/results/:
get:
tags:
- 无元数据分析
summary: 获取无元数据分析结果
description: 获取无元数据分析的结果数据
operationId: getMetaFreeResults
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取结果
content:
application/json:
schema:
type: object
'404':
description: 项目不存在或无结果
/projects/{project_id}/meta-free/export/:
get:
tags:
- 无元数据分析
summary: 导出无元数据分析结果
description: 下载无元数据分析结果文件
operationId: exportMetaFreeResults
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
- name: format
in: query
description: 导出格式
schema:
type: string
enum: [png, svg, pdf, csv, rds]
responses:
'200':
description: 文件下载
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: 项目或结果不存在
/projects/{project_id}/meta-based/status/:
get:
tags:
- 基于元数据分析
summary: 获取基于元数据分析状态
description: 获取项目的最新基于元数据分析任务状态
operationId: getMetaBasedStatus
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取状态
'404':
description: 项目不存在
/projects/{project_id}/meta-based/:
post:
tags:
- 基于元数据分析
summary: 执行基于元数据分析
description: |
执行基于元数据的高级分析方法。
支持的分析方法：
- 分类分析（SVM、随机森林、逻辑回归）
- 回归分析（线性回归、PLSR）
- 统计检验（ANOVA、多重比较、非参数检验）
- 生物标志物发现
operationId: runMetaBasedAnalysis
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
metadata_file:
type: string
format: binary
description: 元数据CSV文件
analysis_methods:
type: string
description: 分析方法列表（JSON字符串）
parameters:
type: string
description: 分析参数（JSON字符串）
responses:
'200':
description: 分析完成
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
result:
type: object
'400':
description: 项目状态不适合进行分析或元数据文件格式错误
'404':
description: 项目不存在
'500':
description: 分析执行失败
/projects/{project_id}/meta-based/results/:
get:
tags:
- 基于元数据分析
summary: 获取基于元数据分析结果
description: 获取基于元数据分析的结果数据
operationId: getMetaBasedResults
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取结果
content:
application/json:
schema:
type: object
'404':
description: 项目不存在或无结果
/projects/{project_id}/meta-based/export/:
get:
tags:
- 基于元数据分析
summary: 导出基于元数据分析结果
description: 下载基于元数据分析结果文件
operationId: exportMetaBasedResults
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
- name: format
in: query
description: 导出格式
schema:
type: string
enum: [png, svg, pdf, csv, excel, rds]
responses:
'200':
description: 文件下载
content:
application/octet-stream:
schema:
type: string
format: binary
'404':
description: 项目或结果不存在
/projects/{project_id}/results/summary/:
get:
tags:
- 结果管理
summary: 获取结果摘要
description: 获取项目所有分析结果的摘要信息
operationId: getResultsSummary
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取结果摘要
content:
application/json:
schema:
type: object
properties:
project_info:
$ref: '#/components/schemas/Project'
preprocessing_status:
type: string
meta_free_status:
type: string
meta_based_status:
type: string
available_exports:
type: array
items:
type: string
'404':
description: 项目不存在
/projects/{project_id}/results/export/:
post:
tags:
- 结果管理
summary: 创建导出任务
description: 创建一个结果导出任务
operationId: createExportTask
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
format:
type: string
enum: [zip, pdf, excel]
description: 导出格式
components:
type: array
items:
type: string
description: 要导出的组件列表
example: ["preprocessing", "pca", "lda"]
responses:
'201':
description: 导出任务创建成功
content:
application/json:
schema:
type: object
properties:
export_id:
type: string
format: uuid
status:
type: string
message:
type: string
'400':
description: 请求参数错误
'404':
description: 项目不存在
/projects/{project_id}/results/export/{export_id}/:
get:
tags:
- 结果管理
summary: 获取导出任务状态
description: 获取指定导出任务的状态和下载链接
operationId: getExportStatus
security:
- TokenAuth: []
parameters:
- name: project_id
in: path
required: true
schema:
type: string
format: uuid
- name: export_id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: 成功获取导出状态
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum: [pending, processing, completed, error]
download_url:
type: string
description: 下载链接（仅当status为completed时）
created_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
'404':
description: 项目或导出任务不存在
|