Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kings1990 committed Mar 30, 2024
1 parent dcdce39 commit bc0b187
Show file tree
Hide file tree
Showing 13 changed files with 50 additions and 40 deletions.
6 changes: 3 additions & 3 deletions docs/.vuepress/layouts/Layout.vue
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<script setup lang="ts">
import {usePageData, usePageFrontmatter} from "vuepress/client";
import {ref, watch} from "vue";
import { usePageData, usePageFrontmatter } from "vuepress/client";
import { ref, watch } from "vue";
import CommonWrapper from "@theme-hope/components/CommonWrapper";
import HomePage from "@theme-hope/components/HomePage";
import NormalPage from "@theme-hope/components/NormalPage";
import SkipLink from "@theme-hope/components/SkipLink";
import FadeSlideY from "@theme-hope/components/transitions/FadeSlideY";
import type {ThemePageFrontmatter} from "vuepress-theme-hope";
import type { ThemePageFrontmatter } from "vuepress-theme-hope";
const page = usePageData();
const frontmatter = usePageFrontmatter<ThemePageFrontmatter>();
Expand Down
4 changes: 2 additions & 2 deletions docs/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export const enSidebar = sidebar({
"saveRequest",
"tempRequest",
"apifox",
"postmanSync",
"postmanSync",
"regenerate",
"curlImport",
"copyCurl",
Expand Down Expand Up @@ -126,7 +126,7 @@ export const zhSidebar = sidebar({
"saveRequest",
"tempRequest",
"apifox",
"postmanSync",
"postmanSync",
"regenerate",
"curlImport",
"copyCurl",
Expand Down
2 changes: 1 addition & 1 deletion docs/.vuepress/styles/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ h2 {
.vp-project-home {
background-size: contain;
background-repeat: no-repeat;

h2 {
border-bottom: none;
}
Expand Down
10 changes: 5 additions & 5 deletions docs/.vuepress/theme.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import {getDirname, path} from "vuepress/utils";
import {hopeTheme} from "vuepress-theme-hope";
import {enNavbar, zhNavbar} from "./navbar.js";
import {enSidebar, zhSidebar} from "./sidebar.js";
import { getDirname, path } from "vuepress/utils";
import { hopeTheme } from "vuepress-theme-hope";
import { enNavbar, zhNavbar } from "./navbar.js";
import { enSidebar, zhSidebar } from "./sidebar.js";

const __dirname = getDirname(import.meta.url);

Expand Down Expand Up @@ -53,7 +53,7 @@ export default hopeTheme(
// },

components: {
components: ["Badge", "BiliBili", "SiteInfo", "VPCard","VPBanner"],
components: ["Badge", "BiliBili", "SiteInfo", "VPCard", "VPBanner"],
rootComponents: {
notice: [
{
Expand Down
6 changes: 3 additions & 3 deletions docs/en/guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ icon: faq
[[toc]]

## S: Slow operations are prohibited on EDT

`Slow operations are prohibited on EDT` error.

Fill into the keywords `ide.slow.operations.assertion` in **SearchEveryWhere** and uncheck them like following.
Fill into the keywords `ide.slow.operations.assertion` in **SearchEveryWhere** and uncheck them like following.

![slowOperationsConfig](/img/faq/slowOperationsConfig.png)


## S: Send button is disabled, but there is no notification message

You need to manually turn on the notification message. If notification messages are not turned on, many messages cannot be displayed, so IDEA's message notification settings need to be configured. Other situations are handled similarly.
Expand Down Expand Up @@ -205,7 +205,7 @@ import org.springframework.context.annotation.Configuration;

@Configuration
public class WebConfig {

@Bean
public ConfigurableServletWebServerFactory webServerFactory() {
TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
Expand Down
15 changes: 8 additions & 7 deletions docs/en/guide/features/apifox.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,27 +11,28 @@ Version required: <Badge text="2024.1.4+" />
Setting path: `Avatar -> Account Setting-> API Access Token`

::: tip Expiration
Note that after the validity period of the Api key, the plugin's Apifox synchronization function will no longer work,
Note that after the validity period of the Api key, the plugin's Apifox synchronization function will no longer work,
so it is recommended to check `no Expriation` when creating the Api Access token.
:::

## 2. Mapping project

![apifoxConfigProject](/img/features/apifoxConfigProject_en.png)

After we have correctly set the Api access token, we need to make a mapping association between the IDEA project
and the Apifox project. Click to refresh the project. When the project is loaded, click on the team option and
After we have correctly set the Api access token, we need to make a mapping association between the IDEA project
and the Apifox project. Click to refresh the project. When the project is loaded, click on the team option and
check the target project.

## 3. Environment sync

![apifoxSyncEnvironment](/img/features/apifoxSyncEnvironment_en.png)

Environment sync function will synchronize all domain names, variables, and global parameters of the project to Apifox
Environment sync function will synchronize all domain names, variables, and global parameters of the project to Apifox
as service parameters, variables, and global parameters. It is recommended to execute this step before **API sync**


## 4. API sync

![apifoxSyncApi](/img/features/apifoxSyncApi_en.png)

To synchronize the API, you need to save the API first. It can be triggered manually or automatically.
For automatic triggering, you need to check the `Sync after save` option in the Apifox sync setting.
To synchronize the API, you need to save the API first. It can be triggered manually or automatically.
For automatic triggering, you need to check the `Sync after save` option in the Apifox sync setting.
22 changes: 13 additions & 9 deletions docs/en/guide/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ Join and follow us to solve your question ❤️❤️❤️↓↓↓
| [![Slack](https://img.shields.io/static/v1?label=Slack&message=Restful%20Fast%20Request&logo=slack&color=38B580)](https://join.slack.com/t/restfulfastrequest/shared_invite/zt-1we57vum8-TALhTHI2uNmPF2bx1NDyWw) | [![twitter](https://img.shields.io/static/v1?label=Twitter&message=FastRequest666&logo=twitter&color=FC8D34)](https://twitter.com/FastRequest666) |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![slack](/img/slack.png) | ![twitter](/img/twitter.png) |

:::

> **Because developing version is still in development, the documentation of developing version may not be entirely accurate and is subject to change.**
## 2024.1.4 <Badge text="Free trial" type="tip"/> <Badge text="developing" type="info"/> <Badge text="IDEA 2022.3+" color="pink"/>
## 2024.1.4 <Badge text="Free trial" type="tip"/> <Badge text="developing" type="info"/> <Badge text="IDEA 2022.3+" color="pink"/>

- <Badge text="Apifox integration" color="orange"/>
- <Badge text="AI support optimization" color="orange"/>
- <Badge text="Change moduleHeader to apiHeader" type="info"/>
Expand Down Expand Up @@ -47,23 +49,25 @@ The following is a case of using AI to help optimize JSON messages
@tab Summary

```
You are an excellent JSON handler. Whenever a user sends you a JSON, you should respond to
the user in a fixed JSON formatand replace the values in the JSON fields with
human-readable content according to the meaning of the JSON keys. You will only modify
You are an excellent JSON handler. Whenever a user sends you a JSON, you should respond to
the user in a fixed JSON formatand replace the values in the JSON fields with
human-readable content according to the meaning of the JSON keys. You will only modify
the values in the JSON without changing its structure.
```

@tab Example question

```json
{"id":1,"title":"title_ahska","simpleDesc":"simpleDesc_ohga1"}
{ "id": 1, "title": "title_ahska", "simpleDesc": "simpleDesc_ohga1" }
```

@tab Example question's answer

```json
{
"id":1,
"title":"Harry Potter and the Philosopher's Stone",
"simpleDesc":"Join Harry Potter on a thrilling adventure at Hogwarts School of Witchcraft and Wizardry as he uncovers dangerous secrets and saves the rewarding world."
"id": 1,
"title": "Harry Potter and the Philosopher's Stone",
"simpleDesc": "Join Harry Potter on a thrilling adventure at Hogwarts School of Witchcraft and Wizardry as he uncovers dangerous secrets and saves the rewarding world."
}
```

Expand All @@ -79,8 +83,8 @@ the values in the JSON without changing its structure.

:::


## 2024.1.3 <Badge text="Free trial" type="tip"/> <Badge text="Newest version" color="pink"/> <Badge text="2024-03-04" color="SandyBrown"/>

- <Badge text="AI support optimization" color="orange"/>
- <Badge text="Performance optimization for large response results" type="info"/>
- <Badge text="Map type parse optimization" type="info"/>
Expand Down
2 changes: 2 additions & 0 deletions docs/en/guide/whatsnew.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,15 @@ Because developing version is still in development, the documentation of develop
[**More detail ---------------->**](./history.md)

## 2024.1.4 <Badge text="Free trial" type="tip"/> <Badge text="developing" type="info"/>

- <Badge text="Apifox integration" color="orange"/>
- <Badge text="AI support optimization" color="orange"/>
- <Badge text="Change moduleHeader to apiHeader" type="info"/>
- <Badge text="Entity parse optimization" type="info"/>
- <Badge text="API export file suffix error" type="danger"/>

## 2024.1.3 <Badge text="Free trial" type="tip"/> <Badge text="Newest version" color="pink"/> <Badge text="2024-03-04" color="SandyBrown"/>

- <Badge text="AI support optimization" color="orange"/>
- <Badge text="Performance optimization for large response results" type="info"/>
- <Badge text="Map type parse optimization" type="info"/>
Expand Down
3 changes: 2 additions & 1 deletion docs/guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ icon: faq
[[toc]]

## S: Slow operations are prohibited on EDT

报错`Slow operations are prohibited on EDT`相关错误。

在 SearchEveryWhere 中输入关键字 `ide.slow.operations.assertion` ,并将下图所示的关闭。
Expand Down Expand Up @@ -204,7 +205,7 @@ import org.springframework.context.annotation.Configuration;

@Configuration
public class WebConfig {

@Bean
public ConfigurableServletWebServerFactory webServerFactory() {
TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
Expand Down
5 changes: 3 additions & 2 deletions docs/guide/features/apifox.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,14 @@

当我们正确设置好 Api access token 之后,需要对 IDEA 项目与 Apifox 的项目进行一个映射关联,点击刷新项目,当项目加载完毕以后,点开团队选项,勾选对应的项目即可。


## 3. 同步 Environment

![apifoxSyncEnvironment](/img/features/apifoxSyncEnvironment.png)

同步 Environment 会将项目的不同环境的域名、变量、全局参数全部同步至 Apifox,作为 Apifox 的服务参数、变量以及全局参数。这一步建议放在 API 同步之前**先执行**

## 4. 同步 API

![apifoxSyncApi](/img/features/apifoxSyncApi.png)

同步 API 需要先将 API 进行保存,可以手动触发,也可以自动触发,自动触发需要在 Apifox 同步设置中勾选`保存 API 后同步 Apifox`选项。
同步 API 需要先将 API 进行保存,可以手动触发,也可以自动触发,自动触发需要在 Apifox 同步设置中勾选`保存 API 后同步 Apifox`选项。
1 change: 0 additions & 1 deletion docs/guide/getstarted/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ color="#eee"
]'
/>


::: tabs

@tab 付费版
Expand Down
12 changes: 6 additions & 6 deletions docs/guide/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ icon: changelog

购买**License**流程请参考[**购买插件**](./buy.md) 或者进入微信群里查看**群公告**,Issue 提报请到[_Github_](https://github.com/dromara/fast-request/issues)



| ![微信技术群](https://img.shields.io/static/v1?label=wechat&message=微信技术群&logo=wechat&color=07C160) | [![twitter](https://img.shields.io/static/v1?label=Twitter&message=FastRequest666&logo=twitter&color=FC8D34)](https://twitter.com/FastRequest666) |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| ![wechat group](/img/wechatGroup.png) | ![twitter](/img/twitter.png) |
Expand All @@ -21,6 +19,7 @@ icon: changelog
> **由于开发版本仍在开发中,开发版本的文档可能不完全准确,因此可能会发生变化。**
## 2024.1.4 <Badge text="免费试用" type="tip"/> <Badge text="开发中..." type="info"/> <Badge text="IDEA 2022.3+" color="pink"/>

- <Badge text="Apifox 集成" color="orange"/>
- <Badge text="AI支持优化" color="orange"/>
- <Badge text="变更 moduleHeader 为 apiHeader" type="info"/>
Expand Down Expand Up @@ -50,16 +49,18 @@ Apifox集成,支持同步 API、环境变量、域名信息等。只要配置
@tab 概述

```
你是一位优秀的 JSON 处理程序。每当用户向您发送 JSON 时,您都应该以固定的 JSON 格式响应用户,并根据
你是一位优秀的 JSON 处理程序。每当用户向您发送 JSON 时,您都应该以固定的 JSON 格式响应用户,并根据
JSON 键的含义将 JSON 字段中的值替换为人类可读的内容。您只需修改 JSON 中的值,而无需更改其结构。
```

@tab 提问范例

```
{"id":1,"title":"title_ahska","simpleDesc":"simpleDesc_ohga1","content":"content_yujga"}
```

@tab 提问范例结果

```
{"id":1,"title":"书画标题","simpleDesc":"简介内容","content":"整体内容"}
```
Expand All @@ -72,13 +73,12 @@ JSON 键的含义将 JSON 字段中的值替换为人类可读的内容。您只

1. 前置、后置脚本中的变量 `moduleHeader` 变更 `为apiHeader`
2. 主界面 Header 选项卡作用域变更为仅面向 API 级别,
即每个 API 可以拥有不同的 Header,如果需要公共 Header,请前往[项目级别 Header](/guide/features/projectValueConfig.md) 设置。
即每个 API 可以拥有不同的 Header,如果需要公共 Header,请前往[项目级别 Header](/guide/features/projectValueConfig.md) 设置。

:::



## 2024.1.3 <Badge text="免费试用" type="tip"/> <Badge text="最新版" color="pink"/> <Badge text="2024-03-04" color="SandyBrown"/>

- <Badge text="AI支持优化" color="orange"/>
- <Badge text="超大响应结果性能优化" type="info"/>
- <Badge text="Map入参类型解析优化" type="info"/>
Expand Down
2 changes: 2 additions & 0 deletions docs/guide/whatsnew.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,15 @@ important: <Badge text="重要功能" color="orange"/> <span>&nbsp;&nbsp;&nbsp;&
[**务必查看变更详情----------------->**](./history.md)

## 2024.1.4 <Badge text="免费试用" type="tip"/> <Badge text="开发中..." type="pink"/>

- <Badge text="Apifox 集成" color="orange"/>
- <Badge text="AI支持优化" color="orange"/>
- <Badge text="变更 moduleHeader 为 apiHeader" type="info"/>
- <Badge text="实体解析优化" type="info"/>
- <Badge text="API 导出文件后缀错误" type="danger"/>

## 2024.1.3 <Badge text="免费试用" type="tip"/> <Badge text="最新版" type="pink"/> <Badge text="2024-03-04" color="SandyBrown"/>

- <Badge text="AI支持优化" color="orange"/>
- <Badge text="超大响应结果性能优化" type="info"/>
- <Badge text="Map入参类型解析优化" type="info"/>
Expand Down

0 comments on commit bc0b187

Please sign in to comment.