AI Skill 大全

Encore 类型化接口开发

输入接口路径、请求字段和业务需求,生成带类型定义、参数校验及错误处理的 Encore.ts 接口代码。

功能与用途

用于在 Encore.ts 项目中新增或完善业务接口。提供请求方法、路由路径、输入字段、返回结构和业务逻辑要求,即可生成明确的请求与响应类型,配置路径参数、查询参数、请求头或 Cookie,并加入邮箱、长度、数值范围等校验。支持设置公开访问、认证要求、自定义状态码和标准错误响应,也可配置静态文件路由。适合已有 Encore.ts 项目且能阅读 TypeScript 的开发者。

适用场景

  • 新增用户注册接口:定义注册请求与返回类型,校验邮箱及用户名长度,并为重复注册返回标准错误。
  • 编写分页查询接口:为用户列表配置分页查询参数、数值范围约束和明确的列表响应结构。
  • 统一资源查询错误:从路由提取资源编号,查询不到记录时抛出 APIError.notFound。
  • 提供前端静态文件:将构建目录映射为静态资源路由,配置根路径回退与自定义错误页面。

适用人群

  • Encore.ts 后端开发者
  • TypeScript 全栈工程师
  • 维护 Encore.ts 业务接口的开发团队

使用步骤

  1. 提供 Encore.ts 服务代码或目标接口需求。
  2. 说明请求方法、路径、输入字段和返回结构。
  3. 补充校验约束、访问要求及异常情况。
  4. 生成接口代码并接入项目业务逻辑。
  5. 在项目中验证正常请求、参数错误和资源缺失场景。

开始使用

将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。

查看 MCP 接入说明

技术信息

分类
编程
适用工具
Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
使用难度
进阶
版本
main
最近更新
2026-11-03
文件数
3
安装包大小
自动生成 ZIP
安全检查
基础检查通过

Define typed API endpoints in Encore.ts using `api(...)` from `encore.dev/api`. Covers typed request/response interfaces, path/query/header/cookie params, request validation, and `APIError`. For raw endpoints (`api.raw()`) and inbound webhooks, use `encore-webhook` instead.

使用前准备

  • 已有 Encore.ts 项目,能够添加或修改服务代码。
  • 了解 TypeScript 接口、异步函数和基本 HTTP 请求概念。
  • 准备好接口路径、字段定义、返回结构与业务逻辑要求。

同类 Skill