From 5975a992b26a8aa293eb44128dbe23535246b0f9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=83=A1=E9=95=87?= Date: Mon, 9 Sep 2024 16:50:25 +0800 Subject: [PATCH] docs: rewrite extension part in introduce --- .../tutorial/02-getting-started/01-introduce.md | 17 ++++++++++------- .../tutorial/02-getting-started/01-introduce.md | 17 ++++++++++------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/docs/tutorial/02-getting-started/01-introduce.md b/docs/tutorial/02-getting-started/01-introduce.md index e27f60e34c..251b69453a 100644 --- a/docs/tutorial/02-getting-started/01-introduce.md +++ b/docs/tutorial/02-getting-started/01-introduce.md @@ -71,17 +71,20 @@ const { alova provides 15+ request strategy modules based on the [RSM](/about/RSM) specification, which are implemented in the form of useHook. -### Alova editor extension +### Editor extension -Using the alova extension in vscode can help you automatically generate request codes with complete API document annotations and response types. Whether it is a ts project or a js project, you can get complete interface queries, interface details, and smart prompts for response data types. +Using the alova extension in vscode can automatically generate three pieces of API information for you at the same time. They are API request code, corresponding request parameters and response types, and complete documentation for the corresponding API. Whether it is a ts project or a js project, you can get complete API intelliSense of editor. In addition, you can quickly view API documentation in the editor. -This extension also optimizes the API usage process, allowing you to experience a different API integration experience. In the past, you needed to query the API documentation first, and constantly switch between the API documentation and the editor to write request code. After using the alova plug-in, you no longer need to leave the editor and can directly use the API in the editor while checking. - -import vscodeDemoVideo from '@site/static/video/vscode-demo-video-en.mp4'; +```mermaid +flowchart LR +R1[OpenAPI file] --> S1[Alova Extension] --> W1[API functions] +S1[Alova Extension] --> W2[complete API types] +S1[Alova Extension] --> W3[complete API documentation] +``` -