api-rest-collection

分类: 测试与安全 | 上传者: igmarin | 下载: 0 | 版本: v1.0（最新）

在创建或修改 REST API 端点（Rails 控制器、引擎路由、API 操作）时使用。需要生成或更新 API 集合文件（例如 Postman Collection v2.1），以便可以测试新的或更改的端点。触发词：端点、API 路由、控制器操作、API 集合、请求集合。 --- # REST API 集合在添加或更改 REST API 端点时使用此技能，以便生成或更新兼容的集合文件以在现代 API 客户端中进行测试。 **核心原则：** 每个 API 表面（Rails 应用程序或引擎）都有一个与其端点保持同步的 API 集合文件。集合中的所有名称、描述和变量标签都必须采用**英文**。 ## 快速参考 |方面|规则| |--------|------| |当 |创建或修改任何 REST API 端点（路由 + 控制器操作）时创建或更新集合 | |格式| Postman Collection JSON v2.1（`schema` 或 `info.schema` 引用 v2.1）是一个很好的默认标准。 | |地点 |每个应用程序或引擎一个文件，例如`docs/api-collections/<app-or-engine-name>.json` 或 `spec/fixtures/api-collections/` | |语言 |集合中的所有请求名称、描述和变量名称均采用 **英语** | |根据要求 |方法、URL（带有基本 URL 的变量）、标头（内容类型、授权（如果需要））、正文示例（如果适用）| ## HARD-GATE：在端点更改时生成 ``` 当您创建或修改 REST API 端点（新的或更改的路由和控制器操作）时，您还必须创建或更新相应的 API 集合文件，以便可以测试流程。不要让收藏丢失或过时。

更新日志: Source: GitHub https://github.com/igmarin/rails-agent-skills

目录结构

当前层级: tree/main/api-rest-collection/

📄 SKILL.md 4.9 KB

SKILL.md

---
name: api-rest-collection
description: >
  Use when creating or modifying REST API endpoints (Rails controllers, engine routes,
  API actions). Requires generating or updating an API Collection file (e.g., Postman
  Collection v2.1) so the new or changed endpoints can be tested. Trigger words:
  endpoint, API route, controller action, API collection, request collection.
---
# REST API Collection

Use this skill when you add or change a REST API endpoint so that a compatible collection file is generated or updated for testing in a modern API client.

**Core principle:** Every API surface (Rails app or engine) has a single API collection file that stays in sync with its endpoints. All names, descriptions, and variable labels in the collection must be in **English**.

## Quick Reference

| Aspect | Rule |
|--------|------|
| When | Create or update collection when creating or modifying any REST API endpoint (route + controller action) |
| Format | Postman Collection JSON v2.1 (`schema` or `info.schema` references v2.1) is a good default standard. |
| Location | One file per app or engine, e.g. `docs/api-collections/<app-or-engine-name>.json` or `spec/fixtures/api-collections/` |
| Language | All request names, descriptions, and variable names in the collection in **English** |
| Per request | method, URL (with variables for base URL), headers (Content-Type, Authorization if needed), body example when applicable |

## HARD-GATE: Generate on Endpoint Change

```
When you create or modify a REST API endpoint (new or changed route and controller action),
you MUST also create or update the corresponding API collection file so the
flow can be tested. Do not leave the collection missing or outdated.

EXCEPTION: GraphQL endpoints do NOT use REST collections.
For GraphQL, use a dedicated GraphQL client — see note below.
```

## GraphQL Endpoints

Do **not** use this skill for GraphQL endpoints. REST collections do not map cleanly to GraphQL queries and mutations. For GraphQL:

- Use **Insomnia** (preferred) or **GraphQL Playground** for manual testing
- Import the schema directly via introspection or SDL file
- Store an Insomnia workspace export in `docs/insomnia/` if the team needs a shared config

See **rails-graphql-best-practices** for the full GraphQL conventions.

## Language

All generated content in the collection must be in **English**: request names, folder names, descriptions, and variable display names. Do not use another language unless the user explicitly requests it.

## Collection Structure (Postman v2.1 Example)

- **Root:** `info` (name, description, schema `https://schema.getpostman.com/json/collection/v2.1.0/collection.json`), `item` array.
- **Each request (item):** `name` (English), optional `request` with `method`, `url` (string or object with `raw`/`host`/`path`/`variable`), `header` array, `body` when applicable (e.g. raw JSON for POST/PUT).
- Use **variables** for base URL (e.g. `{{base_url}}`) so the collection works across environments.

## Where to Put the File

- Prefer a single collection per application or engine.
- Suggested paths: `docs/api-collections/<name>.json` or `spec/fixtures/api-collections/<name>.json`.
- If the repo already has a collection folder, use that location and update the existing file.

## Example Snippet (structure only)

```json
{
  "info": {
    "name": "My Engine API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "item": [
    {
      "name": "Create resource",
      "request": {
        "method": "POST",
        "header": [{ "key": "Content-Type", "value": "application/json" }],
        "url": "{{base_url}}/resources",
        "body": { "mode": "raw", "raw": "{\"name\": \"Example\"}" }
      }
    }
  ],
  "variable": [{ "key": "base_url", "value": "http://localhost:3000" }]
}
```

## Common Mistakes

| Mistake | Reality |
|---------|---------|
| Adding an endpoint but not touching the collection | Collection must be updated so the new flow is testable in an API client |
| Using a language other than English for names/descriptions | Standard is English unless the user requests otherwise |
| Hardcoding full URLs instead of variables | Use `{{base_url}}` (or similar) so the collection works in dev/staging/prod |
| Missing Content-Type or body for POST/PUT | Include headers and example body so the request works out of the box |

## Red Flags

- New or changed endpoint with no corresponding API collection update
- Collection file path not documented or inconsistent across the project
- Request names or descriptions in a language other than English without user request

## Integration

| Skill | When to chain |
|-------|----------------|
| **rails-engine-author** | When the engine exposes HTTP endpoints |
| **rails-engine-docs** | When documenting engine API or how to test endpoints |
| **rails-code-review** | When reviewing API changes (ensure collection was updated) |
| **rails-engine-testing** | When adding request/routing specs (collection can mirror those flows) |

登录后下载/点赞/收藏 ❤ 8 | ★ 0

api-rest-collection

目录结构

SKILL.md

举报内容

提示