Skip to content

Commit

Permalink
docs: 更新文档笔误
Browse files Browse the repository at this point in the history
  • Loading branch information
yangqianjun committed Sep 2, 2021
1 parent dff4d2f commit 1670979
Show file tree
Hide file tree
Showing 17 changed files with 24 additions and 54 deletions.
32 changes: 1 addition & 31 deletions GettingStarted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -211,37 +211,7 @@ Autos 生成的 Service 代码内包含以下和后端进行通信的固定代
import ajax, { AjaxPromise, ExtraFetchParams } from '@ajax';
```

你可以直接使用与 Auto 配套的 `@ajax` 模块实现,tkit-ajax ([文档](<](https://www.npmjs.com/package/tkit-ajax)>))。

通过 npm 安装 tkit-ajax:

```
npm i tkit-ajax -S
```

配置 tsconfig.json:

```json
{
"compilerOptions": {
"paths": {
"@ajax": ["node_modules/@tkit/ajax"]
}
}
}
```

如直接使用 tkit-ajax, 后端返回数据格式必须满足:

```ts
{
code?: number;
message?: string;
result: R;
}
```

你也可以按照以下接口定义,实现自定义的 `@ajax` 模块:
你可以参考 [@ekit/ajax](https://github.com/e-kit/ekit/blob/master/packages/ajax/src/new-ajax.ts) 代码实现自定义的 `@ajax` 模块,或者按照以下接口定义,实现自定义的 `@ajax` 模块:

```ts
/** 不再兼容非标准的数据结构 */
Expand Down
16 changes: 8 additions & 8 deletions docs/assets.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"vendors.js": "/auto-service/static/js/vendors.35ef962c.js",
"vendors.js.map": "/auto-service/static/js/vendors.5a0a1637c48b98291a25.js.map",
"app.js": "/auto-service/static/js/app.5a0a1637c48b98291a25.js",
"app.js.map": "/auto-service/static/js/app.5a0a1637c48b98291a25.js.map",
"getting-started.js": "/auto-service/static/js/getting-started.e1f5d65c.js",
"getting-started.js.map": "/auto-service/static/js/getting-started.5a0a1637c48b98291a25.js.map",
"vendors.js.map": "/auto-service/static/js/vendors.7e8f0e8838371f4cafd6.js.map",
"app.js": "/auto-service/static/js/app.7e8f0e8838371f4cafd6.js",
"app.js.map": "/auto-service/static/js/app.7e8f0e8838371f4cafd6.js.map",
"getting-started.js": "/auto-service/static/js/getting-started.4f615218.js",
"getting-started.js.map": "/auto-service/static/js/getting-started.7e8f0e8838371f4cafd6.js.map",
"readme.js": "/auto-service/static/js/readme.d1053ec1.js",
"readme.js.map": "/auto-service/static/js/readme.5a0a1637c48b98291a25.js.map",
"src-validate-readme.js": "/auto-service/static/js/src-validate-readme.77f332ac.js",
"src-validate-readme.js.map": "/auto-service/static/js/src-validate-readme.5a0a1637c48b98291a25.js.map",
"readme.js.map": "/auto-service/static/js/readme.7e8f0e8838371f4cafd6.js.map",
"src-validate-readme.js": "/auto-service/static/js/src-validate-readme.797bbaa7.js",
"src-validate-readme.js.map": "/auto-service/static/js/src-validate-readme.7e8f0e8838371f4cafd6.js.map",
"index.html": "/auto-service/index.html",
"static/img/logo.png": "/auto-service/static/img/logo.f34d6017.png",
"static/img/swagger.png": "/auto-service/static/img/swagger.fcc098d8.png"
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html lang="en"><head><meta charset="UTF-8"><meta name="description" content="auto generate swagger or yapi mock to typescript services and models"><meta name="viewport" content="width=device-width,initial-scale=1"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Autos</title><link rel="icon" type="image/x-icon" href="https://cdn-std.dprcdn.net/files/acc_649651/LUKiMl"></head><body><div id="root"></div><script src="/auto-service/static/js/vendors.35ef962c.js"></script><script src="/auto-service/static/js/app.5a0a1637c48b98291a25.js"></script></body></html>
<!doctype html><html lang="en"><head><meta charset="UTF-8"><meta name="description" content="auto generate swagger or yapi mock to typescript services and models"><meta name="viewport" content="width=device-width,initial-scale=1"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>Autos</title><link rel="icon" type="image/x-icon" href="https://cdn-std.dprcdn.net/files/acc_649651/LUKiMl"></head><body><div id="root"></div><script src="/auto-service/static/js/vendors.35ef962c.js"></script><script src="/auto-service/static/js/app.7e8f0e8838371f4cafd6.js"></script></body></html>
2 changes: 0 additions & 2 deletions docs/static/js/app.5a0a1637c48b98291a25.js

This file was deleted.

2 changes: 2 additions & 0 deletions docs/static/js/app.7e8f0e8838371f4cafd6.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/static/js/getting-started.4f615218.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/static/js/getting-started.5a0a1637c48b98291a25.js.map

This file was deleted.

1 change: 1 addition & 0 deletions docs/static/js/getting-started.7e8f0e8838371f4cafd6.js.map

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions docs/static/js/getting-started.e1f5d65c.js

This file was deleted.

2 changes: 1 addition & 1 deletion docs/static/js/readme.d1053ec1.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Loading

0 comments on commit 1670979

Please sign in to comment.