@@ -8,40 +8,42 @@ The Alibaba Cloud API Toolkit for VSCode makes it easier to access Alibaba Cloud
8
8
9
9
English | [ 简体中文] ( ./README.zh_CN.md )
10
10
11
- ## Features
12
- * ** Alicloud Product Subscription:** You can search for Alicloud products and subscribe to its APIs you want to use.
11
+ ## Features
13
12
14
- * ** API Searching :** You can search the Open API of Alibaba Cloud products to which you are subscribed .
13
+ - ** Alicloud Product Subscription :** You can search for Alicloud products and subscribe to its APIs you want to use .
15
14
16
- * ** API Document View:** Clicking on an API can navigate you to a new tab which displays the corresponding API document,
17
- including descriptions, request parameters, response parameters and error codes.
15
+ - ** API Searching:** You can search the Open API of Alibaba Cloud products to which you are subscribed.
18
16
19
- * ** Call the API:** You can use the form to call the Alibaba Cloud API and see the response.
20
-
21
- * ** SDK Code Sample:** You can get the SDK code samples and quickly open the corresponding SDK code in VS Code.
17
+ - ** API Document View:** Clicking on an API can navigate you to a new tab which displays the corresponding API document,
18
+ including descriptions, request parameters, response parameters and error codes.
22
19
23
- * ** Code Snippets:** You can use the code snippets to quickly generate the code.
20
+ - ** Call the API:** You can use the form to call the Alibaba Cloud API and see the response.
21
+ - ** SDK Code Sample:** You can get the SDK code samples and quickly open the corresponding SDK code in VS Code.
24
22
25
- * More features are under development, please stay tuned.
23
+ - ** Code Snippets:** You can use the code snippets to quickly generate the code.
24
+
25
+ - More features are under development, please stay tuned.
26
26
27
27
## Extension UI Guide
28
28
29
- ![ VSCode Extension Guide] ( https://img.alicdn.com/imgextra/i1/O1CN01rOmqbK1pOoGtdWxFO_!!6000000005351 -0-tps-2462-1440 .jpg )
29
+ ![ VSCode Extension Guide] ( https://img.alicdn.com/imgextra/i2/O1CN01t993u81InC3xh7RVU_!!6000000000937 -0-tps-2328-1646 .jpg )
30
30
31
31
### Product Searching ` ctrl+cmd+k `
32
-
32
+
33
33
![ Product Searching] ( https://img.alicdn.com/imgextra/i1/O1CN01bcJ5DM1RpmnlOjDHK_!!6000000002161-0-tps-1202-798.jpg )
34
-
34
+
35
35
### API Searching ` ctrl+cmd+l `
36
36
37
- ![ API Serching] ( https://img.alicdn.com/imgextra/i1/O1CN01KaWkBF1UfCUkY0N3v_!!6000000002544 -0-tps-1286-518 .jpg )
37
+ ![ API Serching] ( https://img.alicdn.com/imgextra/i4/O1CN01KCrc1a1vooTmC9a1h_!!6000000006220 -0-tps-1986-542 .jpg )
38
38
39
39
### Call the API
40
40
41
- The feature requires you to configure your AK/SK information as follows:
42
- 1 . Install [ Alibaba Cloud CLI Tools] ( https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli ) extentions.
43
- 2 . Install [ aliyun-cli] ( https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#installation ) .
44
- 3 . You can run the ` aliyun configure ` command for quick configuration.
41
+ The feature requires you to configure your AK/SK information as follows:
42
+
43
+ 1 . Install Aliyun CLI: [ Install guide] ( https://www.alibabacloud.com/help/en/cli/installation-guide ) .
44
+ 2 . Install [ Alibaba Cloud CLI Tools] ( https://marketplace.visualstudio.com/items?itemName=alibabacloud-openapi.aliyuncli ) extentions.
45
+ 3 . You can run the ` aliyun configure ` command for quick configuration.
46
+
45
47
```
46
48
$ aliyun configure
47
49
Configuring profile 'default' ...
@@ -51,20 +53,23 @@ Default Region Id [None]: cn-hangzhou
51
53
Default output format [json]: json
52
54
Default Language [zh]: zh
53
55
```
56
+
54
57
4 . Click the Alibaba Cloud icon in VS Code status bar to manage your profiles.
55
- ![ ] ( https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg )
56
- ![ ] ( https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg )
57
- 5 . More information please refer to the [ Alibaba Cloud CLI Documentation] ( https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure ) .
58
+ ![ ] ( https://img.alicdn.com/imgextra/i1/O1CN0144NU9N1L4G1cq89Uf_!!6000000001245-0-tps-248-46.jpg )
59
+ ![ ] ( https://img.alicdn.com/imgextra/i2/O1CN01btLUkc1ldEHJQ0w4S_!!6000000004841-0-tps-1206-190.jpg )
60
+ More information please refer to the [ Alibaba Cloud CLI Documentation] ( https://github.com/aliyun/aliyun-cli?tab=readme-ov-file#configure ) .
58
61
59
- ![ API debug] ( https://img.alicdn.com/imgextra/i4/O1CN01F1qI7S1BunIFJPiAt_!!6000000000006-0 -tps-2618-2050.jpg )
62
+ ![ API debug] ( https://img.alicdn.com/imgextra/i3/O1CN01yfMcHl1i6lNdjzmzs_!!6000000004364-2 -tps-2688-1820.png )
60
63
61
64
### SDK Code Sample
65
+
62
66
You can generate the SDK Sample by using the debugger form and then open it in your editor.
63
67
64
- ![ sdk demo] ( https://img.alicdn.com/imgextra/i1/O1CN01GVhWTl1waRdYmCn7E_!!6000000006324 -0-tps-2630-2038 .jpg )
68
+ ![ sdk demo] ( https://img.alicdn.com/imgextra/i1/O1CN01C0vQDB29gTtW5erj4_!!6000000008097 -0-tps-2638-1778 .jpg )
65
69
66
70
### Code Snippets
67
- You can use the code snippets to quickly generate the code.
71
+
72
+ You can use the code snippets to quickly generate the code.
68
73
69
74
Type your subscribed API into the editor and select the API snippet you want to generate.
70
75
@@ -74,38 +79,14 @@ Or use the keyboard shortcuts `ctrl+cmd+l` to search the API and select Insert s
74
79
![ code snippets] ( https://img.alicdn.com/imgextra/i3/O1CN01dmGwmX1ZyVHozyKx4_!!6000000003263-1-tps-842-468.gif )
75
80
76
81
## Feedback
77
- Submit bug reports and feature requests on [ our Github repository] ( https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues )
78
- .
79
82
80
- ## Requirements
81
- - Need VS Code 1.75.0 or above.
82
-
83
- ## Release Notes
84
-
85
- ### 0.0.8
86
- - Fixed some Windows compatibility issues.
87
- - Optimized the UI interface of webview.
88
-
89
- ### 0.0.7
90
- - Launch experience satisfaction questionnaire survey
83
+ - Submit bug reports and feature requests on [ our Github repository] ( https://github.com/aliyun/alibabacloud-api-vscode-toolkit/issues ) .
91
84
- You are welcome to submit your questions and suggestions on the [ experience questionnaire] ( https://g.alicdn.com/aes/tracker-survey-preview/0.0.13/survey.html?pid=fePxMy&id=3486 ) .
92
85
93
- ### 0.0.6
94
- - Surpport code snippets.
95
-
96
- ### 0.0.5
97
- - Added aliyun-cli installation instructions.
98
-
99
- ### 0.0.3
100
- - Support API calling.
101
- - Support SDK code sample.
86
+ ## Requirements
102
87
103
- ### 0.0.1
104
- Initial release
105
- - Support product searching and subscription.
106
- - Support API searching.
107
- - Support API Document View.
88
+ - Need VS Code 1.75.0 or above.
108
89
109
90
## License
110
91
111
- See the [ Apache License 2.0] ( ./LICENSE ) .
92
+ See the [ Apache License 2.0] ( ./LICENSE ) .
0 commit comments