快捷键
ExpressKit是轻量级 表达式.js 与 节点Kit 并提供了一些有用的特性,如请求日志,追踪支持,同源控制器和中间软件以及动词路由描述等.
安装 :
npm install --save @gravity-ui/nodekit @gravity-ui/expresskit
基本用途:
import {ExpressKit} from '@gravity-ui/expresskit';
import {NodeKit} from '@gravity-ui/nodekit';
const nodekit = new NodeKit();
const app = new ExpressKit(nodekit, {
'GET /': (req, res) => {
res.send('Hello World!');
},
});
app.run();
自我遥测
默认情况下,自测会发送原始请求 URL. 大型或 高心率查询字符串可以在发送数据前剥去查询参数:
const config: Partial<AppConfig> = {
appTelemetryChEnableSelfStats: true,
appTelemetryChSelfStatsStripQueryParams: true,
};
社区支助方案
config.ts
import type {AppConfig} from '@gravity-ui/nodekit';
import {csp} from '@gravity-ui/expresskit';
const config: Partial<AppConfig> = {
expressCspEnable: true,
expressCspPresets: ({getDefaultPresets}) => {
return getDefaultPresets({defaultNone: true}).concat([
csp.inline(),
{csp.directives.REPORT_TO: 'my-report-group'},
]);
},
expressCspReportTo: [
{
group: 'my-report-group',
max_age: 30 * 60,
endpoints: [{ url: 'https://cspreport.com/send'}],
include_subdomains: true,
}
]
}
export default config;
CSRF 保护
ExpressKit提供内置的 Cross-Site Creat Forgery (CSRF) 保护,以保护您的应用程序免受恶意的交叉源请求. CSRF中间软件会自动生成并验证用于改变状态的HTTP请求的令牌.
基本配置
为了启用 CSRF 保护, 请在配置中配置密钥 :
import type {AppConfig} from '@gravity-ui/nodekit';
const config: Partial<AppConfig> = {
// ...
appCsrfSecret: 'your-secret-key-here',
};
export default config;
配置选项
| 选项 | 类型 | 默认 | 说明 |
|---|---|---|---|
appCsrfSecret | string | string[] | - 说吧 | 要求. HMAC 令牌生成的秘密密钥 。 多个秘密允许密钥旋转. |
appCsrfLifetime | number | 2592000 (30天) (中文(简体) ) | 几秒钟内就结束了 设定为 0 没有过期. |
appCsrfHeaderName | string | 'x-csrf-token' | HTTP 符号验证头名 . |
appCsrfMethods | string[] | ['POST', 'PUT', 'DELETE', 'PATCH'] | 需要CSRF验证的HTTP方法. |
使用量
配置后, CSRF 保护会自动应用到所有带有指定 HTTP 方法的路径:
import {ExpressKit, AuthPolicy} from '@gravity-ui/expresskit';
import {NodeKit} from '@gravity-ui/nodekit';
const nodekit = new NodeKit({
config: {
appCsrfSecret: 'your-secret-key',
appAuthPolicy: AuthPolicy.required,
// Ensure that your middleware sets user id to the originalContext, otherwise CSRF token generation will fail
appAuthHandler: yourAuthHandler,
},
});
const app = new ExpressKit(nodekit, {
'GET /api/form': (req, res) => {
// Token is available in request context
res.json({csrfToken: req.originalContext.get('csrfToken')});
},
'POST /api/submit': (req, res) => {
// This route automatically validates CSRF token
res.json({message: 'Form submitted successfully'});
},
});
Per- Route 配置
您可以为特定路径禁用 CSRF 保护 :
const app = new ExpressKit(nodekit, {
'POST /api/webhook': {
authPolicy: AuthPolicy.required,
disableCsrf: true, // Disable CSRF for this route
handler: (req, res) => {
res.json({message: 'Webhook processed'});
},
},
});
缓存控制
默认情况下, ExpressKit 集 no-cache 所有回复都标注在信头上。 你可以在全球控制这种行为,也可以按路线控制.
全球配置
const config: Partial<AppConfig> = {
expressEnableCaching: true, // Allow caching by default
};
每个路线配置
const app = new ExpressKit(nodekit, {
'GET /api/cached': {
enableCaching: true, // Allow caching for this route
handler: (req, res) => res.json({data: 'cacheable'}),
},
'GET /api/fresh': {
enableCaching: false, // Force no-cache
handler: (req, res) => res.json({data: 'always fresh'}),
},
});
路线级别 enableCaching 覆盖全局设置 。 缓存状态可见于 req.routeInfo.enableCaching。 。 。 .
验证和响应序列化
- 请求验证和响应序列化 - 使用Zod schemas进行自动请求验证和响应序列化.