RamEx / ramexapi.json
zdy10046's picture
deploy RamEx to Hugging Face without binary files
e657e99
Raw
History Blame Contribute Delete
11.8 kB
{"swagger": "2.0", "info": {"title": "RamEx API", "description": "RamEx拉曼光谱分析系统API文档", "termsOfService": "https://www.yourapp.com/terms/", "contact": {"email": "contact@example.com"}, "license": {"name": "BSD License"}, "version": "v1"}, "host": "localhost:8080", "schemes": ["http"], "basePath": "/api", "consumes": ["application/json"], "produces": ["application/json"], "securityDefinitions": {"Basic": {"type": "basic"}}, "security": [{"Basic": []}], "paths": {"/projects/": {"get": {"operationId": "projects_list", "description": "项目视图集", "parameters": [], "responses": {"200": {"description": "", "schema": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}}, "tags": ["projects"]}, "post": {"operationId": "projects_create", "description": "项目视图集", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"201": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["projects"]}, "parameters": []}, "/projects/{id}/": {"get": {"operationId": "projects_read", "description": "项目视图集", "parameters": [], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/ProjectDetail"}}}, "tags": ["projects"]}, "put": {"operationId": "projects_update", "description": "项目视图集", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["projects"]}, "patch": {"operationId": "projects_partial_update", "description": "项目视图集", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/Project"}}], "responses": {"200": {"description": "", "schema": {"$ref": "#/definitions/Project"}}}, "tags": ["projects"]}, "delete": {"operationId": "projects_delete", "description": "删除项目,包括其关联的所有文件和数据", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "id", "in": "path", "description": "A UUID string identifying this 项目.", "required": true, "type": "string", "format": "uuid"}]}, "/projects/{project_id}/data/group_info/": {"get": {"operationId": "projects_data_group_info_list", "description": "获取分组信息视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/data/save_rds/": {"post": {"operationId": "projects_data_save_rds_create", "description": "保存确认的RDS数据视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/data/upload/": {"post": {"operationId": "projects_data_upload_create", "description": "数据上传视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/data/{file_id}/delete/": {"delete": {"operationId": "projects_data_delete_delete", "description": "删除数据文件视图", "parameters": [], "responses": {"204": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}, {"name": "file_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/data/{file_id}/select/": {"post": {"operationId": "projects_data_select_create", "description": "选择活动数据文件视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}, {"name": "file_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/data/{file_id}/update/": {"post": {"operationId": "projects_data_update_create", "description": "更新数据文件视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}, {"name": "file_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-based/": {"post": {"operationId": "projects_meta-based_create", "description": "基于元数据分析任务视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-based/export/": {"get": {"operationId": "projects_meta-based_export_list", "description": "基于元数据分析结果导出视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-based/results/": {"get": {"operationId": "projects_meta-based_results_list", "description": "基于元数据分析结果视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-based/status/": {"get": {"operationId": "projects_meta-based_status_list", "description": "基于元数据分析状态视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-free/": {"post": {"operationId": "projects_meta-free_create", "description": "无元数据分析任务视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-free/export/": {"get": {"operationId": "projects_meta-free_export_list", "description": "无元数据分析结果导出视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-free/results/": {"get": {"operationId": "projects_meta-free_results_list", "description": "无元数据分析结果视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/meta-free/status/": {"get": {"operationId": "projects_meta-free_status_list", "description": "无元数据分析状态视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/preprocessing/": {"post": {"operationId": "projects_preprocessing_create", "description": "预处理任务视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/preprocessing/export/": {"get": {"operationId": "projects_preprocessing_export_list", "description": "预处理数据导出视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/preprocessing/status/": {"get": {"operationId": "projects_preprocessing_status_list", "description": "预处理状态视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/results/export/": {"post": {"operationId": "projects_results_export_create", "description": "导出结果视图", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/results/export/{export_id}/": {"get": {"operationId": "projects_results_export_read", "description": "导出状态视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}, {"name": "export_id", "in": "path", "required": true, "type": "string"}]}, "/projects/{project_id}/results/summary/": {"get": {"operationId": "projects_results_summary_list", "description": "结果摘要视图", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["projects"]}, "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string"}]}, "/token/validate/": {"get": {"operationId": "token_validate_list", "description": "GET方法也支持Token验证(通过URL参数)", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["token"]}, "post": {"operationId": "token_validate_create", "summary": "验证Token", "description": "支持的参数传递方式:\n1. JSON: {\"token\": \"your_token\"}\n2. Form data: token=your_token\n3. URL参数: ?token=your_token\n4. Header: Authorization: Token your_token", "parameters": [], "responses": {"201": {"description": ""}}, "tags": ["token"]}, "parameters": []}, "/user/info/": {"get": {"operationId": "user_info_list", "description": "获取当前用户信息", "parameters": [], "responses": {"200": {"description": ""}}, "tags": ["user"]}, "parameters": []}}, "definitions": {"Project": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "项目名称", "type": "string", "maxLength": 200, "minLength": 1}, "created_at": {"title": "创建时间", "type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"title": "最后修改时间", "type": "string", "format": "date-time", "readOnly": true}, "status": {"title": "项目状态", "type": "string", "enum": ["initialized", "data_loaded", "preprocessing", "preprocessing_completed", "analysis", "completed", "error"], "readOnly": true}}}, "DataFile": {"type": "object", "properties": {"id": {"title": "ID", "type": "integer", "readOnly": true}, "filename": {"title": "文件名", "type": "string", "readOnly": true, "minLength": 1}, "uploaded_at": {"title": "上传时间", "type": "string", "format": "date-time", "readOnly": true}, "wavenumber_min": {"title": "最小波数", "type": "number", "x-nullable": true}, "wavenumber_max": {"title": "最大波数", "type": "number", "x-nullable": true}}}, "ProjectDetail": {"required": ["name"], "type": "object", "properties": {"id": {"title": "Id", "type": "string", "format": "uuid", "readOnly": true}, "name": {"title": "项目名称", "type": "string", "maxLength": 200, "minLength": 1}, "description": {"title": "项目描述", "type": "string"}, "created_at": {"title": "创建时间", "type": "string", "format": "date-time", "readOnly": true}, "last_modified": {"title": "最后修改时间", "type": "string", "format": "date-time", "readOnly": true}, "status": {"title": "项目状态", "type": "string", "enum": ["initialized", "data_loaded", "preprocessing", "preprocessing_completed", "analysis", "completed", "error"], "readOnly": true}, "data_files": {"type": "array", "items": {"$ref": "#/definitions/DataFile"}, "readOnly": true}, "active_data_file": {"$ref": "#/definitions/DataFile"}, "data_files_count": {"title": "Data files count", "type": "string", "readOnly": true}}}}}