Skip to content

Commit e4ff391

Browse files
committed
docs: update docs
1 parent 8e33989 commit e4ff391

61 files changed

Lines changed: 409 additions & 125 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,16 +110,19 @@ api.api.get('/users/:id')
110110
res.json({ success: true, data: user });
111111
});
112112

113-
// 绑定到 Express
113+
// 绑定到 Express(推荐方式)
114114
const app = express();
115115
const router = express.Router();
116116
app.use('/api', router);
117117

118-
api.bindRouter(router, api.checkerExpress);
118+
api.bind({ framework: 'express', router });
119119

120120
app.listen(3000, () => {
121121
console.log('🚀 Server running on http://localhost:3000');
122122
});
123+
124+
// 旧方式(已废弃)
125+
// api.bindRouter(router, api.checkerExpress);
123126
```
124127

125128
### 原生 Zod 类型支持
@@ -164,3 +167,53 @@ api.docs.generateDocs({
164167
});
165168
```
166169

170+
### 框架适配器
171+
172+
ERest 提供统一的 `bind()` 方法支持多种框架:
173+
174+
```typescript
175+
import ERest from 'erest';
176+
import express from 'express';
177+
import Koa from 'koa';
178+
import KoaRouter from '@koa/router';
179+
180+
const api = new ERest({ /* options */ });
181+
182+
// Express(非 forceGroup 模式)
183+
const expressApp = express();
184+
const expressRouter = express.Router();
185+
api.bind({ framework: 'express', router: expressRouter });
186+
expressApp.use('/api', expressRouter);
187+
188+
// Koa(非 forceGroup 模式)
189+
const koaApp = new Koa();
190+
const koaRouter = new KoaRouter();
191+
api.bind({ framework: 'koa', router: koaRouter });
192+
koaApp.use(koaRouter.routes());
193+
194+
// forceGroup 模式(需要 app 和 Router 构造函数)
195+
const apiForceGroup = new ERest({ forceGroup: true, groups: { user: '用户' } });
196+
apiForceGroup.bind({
197+
framework: 'express',
198+
app: expressApp,
199+
router: express.Router
200+
});
201+
```
202+
203+
#### 可用适配器
204+
205+
| 框架 | 类型值 | 适配器类 |
206+
|------|--------|----------|
207+
| Express | `'express'` | `ExpressAdapter` |
208+
| Koa | `'koa'` | `KoaAdapter` |
209+
| @leizm/web | `'leizmweb'` | `LeizmWebAdapter` |
210+
211+
#### 已废弃方法
212+
213+
以下方法已废弃,请使用 `bind()` 替代:
214+
215+
- `bindRouter(router, checker)``bind({ framework: 'express', router })`
216+
- `bindRouterToApp(app, Router, checker)``bind({ framework: 'express', app, router: Router })`
217+
- `bindKoaRouterToApp(app, KoaRouter, checker)``bind({ framework: 'koa', app, router: KoaRouter })`
218+
- `checkerExpress` / `checkerKoa` / `checkerLeiWeb` → 内置于适配器中
219+

docs/CNAME

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/assets/hierarchy.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/icons.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/icons.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/assets/main.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/navigation.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/assets/style.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1595,9 +1595,9 @@
15951595
.container-main {
15961596
grid-template-columns:
15971597
minmax(0, 1fr) minmax(0, 2.5fr) minmax(
1598-
0,
1599-
20rem
1600-
);
1598+
0,
1599+
20rem
1600+
);
16011601
grid-template-areas: "sidebar content toc";
16021602
}
16031603

docs/classes/ERestError.html

Lines changed: 20 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)