# API

> 当用户想写接口、创建 API、生成后端端点、做增删改查接口时使用 — 生成 RESTful API 端点，包含路由、验证和错误处理

- Skill: `lightpointventures/api` (Agent Skill)
- Install (CLI): `npx skillmds@latest add lightpointventures/api`
- Raw SKILL.md: https://api.skillmd.com/api/skills/lightpointventures/api/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: lightpointventures (https://skillmd.com/u/lightpointventures)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/lightpointventures/api

---


# 生成 API 接口

帮用户快速生成一个规范的 API 端点。

## 步骤

### 1. 确定接口需求

如果用户已经说了，直接开始。否则问：

> 你需要什么 API？告诉我：
> - 管理什么资源？（比如用户、文章、订单）
> - 需要哪些操作？（查询列表、查询详情、创建、更新、删除）

### 2. 检测技术栈

查看项目中的后端框架：
- Python: FastAPI / Flask / Django
- Node.js: Express / Nest / Hono
- 没有后端 → 推荐 FastAPI（Python）或 Express（Node.js），问用户选哪个

### 3. 生成代码

为每个操作生成完整的端点：

- **路由定义** — RESTful 风格（GET /users, POST /users, GET /users/:id 等）
- **请求验证** — 参数类型检查、必填验证、格式校验
- **业务逻辑** — 用注释标注"在这里写业务逻辑"，提供示例代码
- **错误处理** — 统一的错误响应格式，常见错误码（400、404、500）
- **响应格式** — 统一的 JSON 响应结构

### 4. 验证

启动服务，用 curl 或测试工具验证接口可以正常响应。

> API 已生成，接口如下：
> （列出所有端点和方法）
> 用 /test 可以生成接口测试。用 /database 连接真实数据库。