增加“API调用操作指引文档”

Author: yyyangw

doc/images/api_create_project_cons.png

@@ -57,12 +57,6 @@ POST /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=create_repository --org_sid=E5BbtAHm2Bh --team_name=project --scm_url=https://github.com/Tencent/CodeAnalysis.git --scm_type=git
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_create_repository_response.png)
-
-
-![create_repository](../../../images/api_create_repository_cons.png)
-
 
 ### 二、设置指定代码库的指定方案的代码度量配置
 #### 1. url请求
@@ -91,12 +85,6 @@ PUT /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/schemes/<s
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=update_scheme_settings --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=47 --scheme_id=9
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_update_scheme_settings_response.png)
-
-
-![create_repository](../../../images/api_update_scheme_settings_cons.png)
-
 
 
 ### 三、创建分析项目
@@ -129,12 +117,6 @@ POST /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=create_project --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=47 --scan_scheme_id=42 --branch=main
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_create_project_response.png)
-
-
-![create_repository](../../../images/api_create_project_cons.png)
-
 
 ### 四、启动任务
 #### 1. url请求
@@ -164,11 +146,6 @@ POST /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=create_scans --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=47 --project_id=48 
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_create_scans_response.png)
-
-
-![create_repository](../../../images/api_create_scans_cons.png)
 
 
 ### 五、轮询任务结果
@@ -199,17 +176,6 @@ GET /server/main/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projects/<
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=get_scan_cons --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=47 --project_id=48 --job_id=20
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_get_scan_cons_1.png)
-![create_repository](../../../images/api_get_scan_cons_2.png)
-此时分析项目正在执行中，调用访问任务结果的api接口后会不断进行轮询，直到项目执行完毕。
-
-![create_repository](../../../images/api_get_scan_cons_3.png)
-![create_repository](../../../images/api_get_scan_cons_4.png)
-
-如果参数填写出现错误，会给出提示。
-![create_repository](../../../images/api_get_scan_cons_5.png)
-
 
 ### 六、获取分析概览
 #### 1. url请求
@@ -238,11 +204,6 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=get_overview --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=47 --project_id=48
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_get_overview_1.png)
-![create_repository](../../../images/api_get_overview_2.png)
-![create_repository](../../../images/api_get_overview_3.png)
-![create_repository](../../../images/api_get_overview_4.png)
 
 
 ### 七、查看扫描问题列表
@@ -272,12 +233,6 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=get_issues --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=48 --project_id=49
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_get_issues_response.png)
-
-
-![create_repository](../../../images/api_get_issues_cons.png)
-
 
 ### 八、查看问题详情
 #### 1. url请求
@@ -307,12 +262,6 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=get_issue_detail --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=48 --project_id=49 --issue_id=185
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_get_issue_detail_response.png)
-
-
-![create_repository](../../../images/api_get_issue_detail_cons.png)
-
 
 ### 九、查看指定项目的圈复杂度问题列表
 #### 1. url请求
@@ -341,12 +290,6 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=get_ccissues --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=48 --project_id=49
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_get_ccissues_response.png)
-
-
-![create_repository](../../../images/api_get_ccissues_cons.png)
-
 
 
 ### 十、查看指定项目的重复文件列表
@@ -376,17 +319,6 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec
 python ScriptsAPI.py --base_url=http://<my_ip>/ --method=get_dupfiles --org_sid=E5BbtAHm2Bh --team_name=project --repo_id=48 --project_id=49
 ```
 
-#### 4. 结果展示
-![create_repository](../../../images/api_get_dupfiles_response.png)
-
-
-![create_repository](../../../images/api_get_dupfiles_cons.png)
-
-
-
-
-
-