# auto_build **Repository Path**: zjy-git/auto_build ## Basic Information - **Project Name**: auto_build - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2021-07-19 - **Last Updated**: 2021-11-04 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README 1. **Entity Schema** * **请求url:** https://192.168.3.203:8889/addEntitySchema/ * **请求方式:** POST, GET * **请求参数:** POST请求，上传entity schema文件，构件体系结构json文件，并保存 * name 保存文件的名字（独有） * FILE 上传的文件 GET请求，返回schema数据 * file_path schema数据 * **响应参数** 响应Json格式数据 post请求返回： ```json { "message": "success", "file_path": "data/schema/entity.json" } ``` get请求返回示例 ```json { "message": "success", "entity":[["人物"], ["人物", "体育人物"], ["人物", "体育人物", "足球远动员"] ], "property": [{"实体": "体育人物"}, {"属性名称": [["name","single_value"]]} ], "tree": [{"name": "人物", "children": [{"name": "人物", "children":[]}]},{}] } ``` 2. **RelationSchema** * **请求url:** https://192.168.3.203:8889/addRelationSchema * **请求方式:** GET, POST * **请求参数:** POST请求，上传relation schema文件 * name 保存文件的名字（独有） * FILE 上传的文件 GET请求 返回relation schema数据 * file_path schema数据 * **响应参数** * **响应参数** 响应Json格式数据 post请求返回： ```json { "message": "success", "file_path": "data/schema/relation.json" } ``` get请求返回： ```json { "message": "success", "data": {"0":{"head": "导演", "relation": "合作", "tail": "演员", "property": ["作品","领域"] }} } ``` 3. **change Entity Schema** * **请求url:** https://192.168.3.203:8889/changeEntity/ * **请求方式:** POST, GET * **请求参数:** POST请求 更新schema实体属性 * file_path schema文件位置 * entity 实体名称 * add list类型 * delete list类型 GET请求 修改实体层级关系 * file_path schema文件位置 * operation_code 操作类型 * operation_code=1 修改实体的名字，其他不变 * entity "体育人物" * name "体育界人物" * * operation_code=2 删除实体 * entity "体育人物" * * operation_code=3 添加实体 * entity "体育人物" * 固有属性 [list类型] * 父实体: "人物" * **响应参数** 响应Json格式数据 POST请求返回： ```json { "message": "success" } ``` GET请求返回示例： ```json { "message": "success" } ``` 4. **change RelationSchema** * **请求url:** https://192.168.3.203:8889/changeRelation/ * **请求方式:** GET * **请求参数:** GET请求 修改relation schema * file_path schema文件位置 * add list类型,list中的元素参照具体数据存储样例 * delete list类型，list中的元素就是id（整数） * **响应参数** * **响应参数** 响应Json格式数据 get请求返回： ```json { "message": "success" } ``` 5. **知识体系** * **请求url:** https://192.168.3.203:8889/knowledge/ * **请求方式:** GET * **请求参数:** GET请求 返回知识体系 * kg_name 知识图谱的名字 * **响应参数** * **响应参数** 响应Json格式数据 get请求返回： ```json { "message": "success", "nodes":["导演","演员"], "links": [{"source":0, "target":1, "name":"合作"}], "tree": [{"name": "人物", "children": [{"name": "人物", "children":[]}]},{}] } ``` 6. **addDataToNeo4j** * **请求url:** https://192.168.3.203:8889/addDataToNeo4j/ * **请求方式:** POST * **请求参数:** 将用户上传的excel中数据导入neo4j中 POST请求 * kg_name 知识图谱的名字 * file 上传的excel文件 * entity_path 用于检查属性的json文件 * relation_path 用于检查关系的json文件 7. **upload_data_csv** * **请求url:** https://192.168.3.203:8889/changeRelation/ * **请求方式:** POST * **请求参数:** POST请求 上传实体数据和关系数据 * file: csv文件 * **响应参数** 响应Json格式数据 get请求返回： ```json { "message": "success", "file_path":"data/csv_file/xxx.csv" } ``` 8. **add_data_csv** * **请求url:** https://192.168.3.203:8889/changeRelation/ * **请求方式:** POST * **请求参数:** POST请求 将实体数据和关系数据导入数据库 * kg_name 知识图谱的名字 * file 上传的excel文件 * entity_path 用于检查属性的json文件 * relation_path 用于检查关系的json文件 * f_e 实体数据路径 * f_r 关系数据路径 * **响应参数** 响应Json格式数据 POST请求返回： ```json { "message": "success", "kg_name":"电网图谱" } ``` 9. **searchGraph** * **请求url:** https://192.168.3.203:8889/searchGraph/ * **请求方式:** GET 搜索图谱并返回 * **请求参数:** * label_type 知识图谱的名字，测试环境下默认为DEV_KG_DATABASE_NAME * node_limit 节点数量限制，默认为1 * link_limit 关系数量限制，默认为1 10. **node_info** 搜索图谱中对应nodeid的节点信息 * **请求url:** https://192.168.3.203:8889/node_info/ * **请求方式:** GET * **请求参数:** * neoId 知识图谱中节点的id * label_type 知识图谱的名字，测试环境下默认为DEV_KG_DATABASE_NAME 11. **talk** 问答 * **请求url:** https://192.168.3.203:8889/api/talk/ * **请求方式:** GET * **请求参数:** * q 问题字符串 默认为空 * label_type 知识图谱的名字，测试环境下默认为DEV_KG_DATABASE_NAME * server_type 默认为空 * qa_type 默认为entity 12. **drop_menu** 下拉菜单选择的内容 * **请求url:** https://192.168.3.203:8889/drop_down_menu/ * **请求方式:** GET * **请求参数:** null * **响应参数** 响应Json格式数据 返回server_type和label_type两个list 13. **createNode** * **请求url:** https://192.168.3.203:8889/createNode/ * **请求方式:** POST GET * **请求参数:** POST请求 根据属性和属性值新增节点 * kg_name 图谱名 * properties_dict 要创建节点的属性和属性值字典，格式如下 ```{"属性":"属性值", "属性":"属性值"}``` GET请求 得到体系结构中实体类别的固有属性 * kg_name 图谱名 * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` GET请求返回： ```json { "property": { "学校":["名字", "地址"] } } ``` 14. **createProperties** * **请求url:** https://192.168.3.203:8889/createProperties/ * **请求方式:** POST 根据neoId为节点创建属性，如果不传neoId则创建相应实体 * **请求参数:** * kg_name 图谱名 * neoId 图谱节点的id * properties_dict 要修改属性的字典，格式如下 ```{"属性":"属性值", "属性":"属性值", ……}``` * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 15. **createRelationshipByName** 根据主客体neoId新建关系 * **请求url:** https://192.168.3.203:8889/createRelationshipByName/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * main_name 主体节点的id * obj_name 客体节点的id * relationship 要新建的关系类型 * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 16. **getNodeById** 根据neoId查所有属性 * **请求url:** https://192.168.3.203:8889/getNodeById/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * neoId 图谱节点的id * **响应参数** 响应Json格式数据 post请求返回： ```json [ { "属性1":"属性值", "属性2":"属性值" } ] ``` 17. **getNodeByName** 根据属性name值查所有属性 * **请求url:** https://192.168.3.203:8889/getNodeByName/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * nodeName 图谱节点属性name的属性值 * **响应参数** 响应Json格式数据 post请求返回： ```json [ { "属性":"属性值", "属性":"属性值" } ] ``` 如果nodeName输入为空，返回格式如下 ```json [ { "属性":"属性值", "属性":"属性值" } ] ``` 18. **modifyPropertiesById** 根据neoId修改属性的属性值 * **请求url:** https://192.168.3.203:8889/modifyPropertiesById/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * neoId 图谱节点的id * properties_dict 要修改属性的字典，格式如下 ```{"要修改的属性":"要修改的属性值", "要修改的属性":"要修改的属性值", ……}``` * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 19. **deleteNodeById** 根据neoId删除节点 * **请求url:** https://192.168.3.203:8889/deleteNodeById/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * neoId 图谱节点的id * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 20. **deleteOnePropertyById** 根据neoId和属性名删除对应的属性 * **请求url:** https://192.168.3.203:8889/deleteOnePropertyById/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * neoId 图谱节点的id * property 要删除的属性 * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 21. **getRelationshipById** 根据关系id查关系的名称 * **请求url:** https://192.168.3.203:8889/getRelationshipById/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * rId 图谱关系的id * **响应参数** 响应Json格式数据 post请求返回： ```json [ { "main_name": "主体name值", "obj_name": "客体name值", "rType": "关系类型" } ] ``` 22. **getRelationshipByType** 根据关系类型查所有具有该关系的主客体 * **请求url:** https://192.168.3.203:8889/getRelationshipByType/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * rType 图谱关系的类型 * **响应参数** 响应Json格式数据 post请求返回： ```json [ { "main_name": "主体name值", "obj_name": "客体name值", "rType": "关系类型", "rId": "关系Id" } ] ``` 如果rType输入为空，返回格式如下 ```json [ { "main_name": "主体name值", "obj_name": "客体name值", "rType": "关系类型", "rId": "关系Id" } ] ``` 23. **modifyRelationship** 根据关系id修改关系的类型 * **请求url:** https://192.168.3.203:8889/modifyRelationship/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * rId 图谱关系的id * updateRelationship 要修改的关系类型 * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 24. **deleteRelationship** 根据关系id删除关系 * **请求url:** https://192.168.3.203:8889/deleteRelationship/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * rId 图谱关系的id * **响应参数** 响应Json格式数据 post请求返回： ```json { "status": "success" } ``` 25. **allNodes** 返回所有图谱名 * **请求url:** https://192.168.3.203:8889/allNodes/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * **响应参数** 响应Json格式数据 post请求返回： ```json [ {"节点name值", "neoId图谱的节点Id"}, {"节点name值", "neoId图谱的节点Id"} ] ``` 26. **queryAndCompareNode** 比较excel批量上传实体和后端实体 * **请求url:** https://192.168.3.203:8889/queryAndCompareNode/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * file 上传的excel文件 * entity_path 用于检查属性的json文件 * **响应参数** 响应Json格式数据 post请求返回：返回三个列表，第一个列表装有新增实体及其属性，第二个列表装有已有实体的新增属性，第三个列表装有已有实体已有属性的值 ```json [ [ { "属性":"属性值", "属性":"属性值", "属性":"属性值" } ], [ ["neoId", "name值", "新增属性", "新增属性的值"] ], [ ["neoId", "name值", "属性", "原有属性的值", "新增属性的值"] ] ] ``` 27. **batchCreateRelationship** 批量上传关系 * **请求url:** https://192.168.3.203:8889/batchCreateRelationshipBatch/ * **请求方式:** POST * **请求参数:** * kg_name 图谱名 * file 上传的excel文件 * relation_path 用于检查关系的json文件 * **响应参数** 响应Json格式数据 post请求返回： ```json { "message": "succuss! 创建图谱成功" } ``` 28. **exportAsJson** 导出图谱数据 * **请求url:** https://192.168.3.203:8889/exportAsJson/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * **响应参数** 响应Json格式数据 GET请求返回： 图谱数据的json文件流 29. **exportAsCsv** 导出图谱数据 * **请求url:** https://192.168.3.203:8889/exportAsCsv/ * **请求方式:** GET * **请求参数:** * kg_name 图谱名 * **响应参数** 响应Json格式数据 GET请求返回： 图谱数据的csv文件流 30. **登录接口** * **请求url:** https://192.168.3.203:8889/account/login * **请求方式:** POST * **请求参数:** 使用JSON格式传输 ````json { "name":"admin", "password":"123456" } ```` * **响应参数说明:** 响应JSON格式数据 ````json {"user": {"id": 2, "name": "admin", "roles": 2}, "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyLCJleHAiOjE2MjkxNDQ5ODh9.rZWhsWOFhOF6XmIZE0aaqjF60H6MjngTB6pOlESzUQk" }, { "error": "用户名或密码错误", } ```` 31. **管理员-管理用户接口** * **请求url:** https://192.168.3.203:8889/account/ * **请求方式:** POST，GET， DELETE， PUT * **请求参数:** 使用JSON格式传输 roles 1为管理员,2为普通用户 POST请求参数 管理员注册新用户 ````json { "name":"t1", "password":"admin", "roles":"2" } ```` GET请求参数 管理员查看用户列表 * page = 1 * size = 10 DELETE请求参数 管理员删除用户 ````json { "name":"t1" } ```` PUT请求参数 管理员修改用户 body json串 name用户名,password修改的密码,roles修改的角色(1为管理员,2普通用户) ````json { "name":"t5", "password":"123456", "roles":2 } ```` * **响应参数说明:** 响应JSON格式数据 POST响应参数 ````json { "message": "注册成功" }, { "error": "注册失败" }, { "error": "用户已存在" }, { "error": "用户无权限", } ```` GET响应参数 ````json { "message": "查询成功", "data": [{"id": 2, "name": "admin", "roles": 2}], "page": 1, "size": 20, "total": 10 }, { "error": "用户无权限" } ```` DELTE响应参数 ````json { "message": "用户已删除" }, { "error": "用户不存在" }, { "error": "用户无权限" } ```` PUT响应参数 ````json { "message": "修改成功" } ```` 32. **管理图谱功能** * **请求url:** https://192.168.3.203:8889/account/mykg * **请求方式:** GET, DELETE * **请求参数:** get请求时，查询图谱 * uid = 2 * page = 1 * size = 10 delete方法时，删除图谱 * kgname * **响应参数说明:** 响应JSON格式数据 GET请求返回结果： ````json { "message": "成功", "page": 1, "size": 20, "total": 103, "kgs":[ {"fields":{ "id":1, "userid":2, "name":"test1", "discription":"测试", "created_at":"datatime格式", "updated_at":"datatime格式" }}] }, { "error": "图谱错误", } ```` DELETE请求返回结果： ````json { "message": "成功" }, { "error": "删除错误", } ````