agentleFS
Sign inStart free
gr219gr219/OpenBA-Kit/skills/api-design/SKILL.md

api-design

Skill0 starsChanged 28 days agoMITView on GitHub

Bản thiết kế tích hợp: các hệ thống phối hợp thế nào

191 other projects use a version of this, 1 of them edited.

Adopted by

Most recently taken up by

Used with

Projects with it also use db-design, everything-claude-code and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • yuexueyuSkill

    db-design

    数据库工程师技能 - Schema设计、索引优化、并发安全、数据库审计。当你涉及数据库表/字段/索引/SQL/迁移/MCP数据库操作、建表改表、写查询时必须使用此技能。即使用户只是说"加个字段"或"查下数据"，也应触发。

    Also in 4 projects that use this

  • InfopibeSkill

    everything-claude-code

    Also in 9 projects that use this

  • mryeastcodeSkill

    everything-claude-code-conventions

    Development conventions and patterns for everything-claude-code. JavaScript project with conventional commits.

    Also in 8 projects that use this

  • tpavanipradeepSkill

    nextjs-turbopack

    Next.js 16+ and Turbopack — incremental bundling, FS caching, dev speed, and when to use Turbopack vs webpack.

    Also in 15 projects that use this

  • Indium-AI-LabsSkill

    data-pipeline-design

    Design batch or incremental ETL and ELT pipelines and warehouse models: grain, partitioning, idempotent loads, late-arriving data, data quality tests, PII controls, and cost monitoring, before building them. Use when adding or changing a dbt model, warehouse table, scheduled transformation, or ingestion job. Not for transactional schema design (use the database-design skill) or event-sourced stores (use the event-sourcing-architecture skill).

    Also in 3 projects that use this

  • thejordanleopoldSkill

    third-party-integration

    Use when integrating with external APIs, payment processors (Stripe), webhooks, or third-party services. Use when implementing API clients with authentication and rate limiting, handling webhooks with signature verification and idempotency, writing contract tests for external services, or isolating third-party dependencies behind adapters. Triggers: \"Stripe\", \"payment integration\", \"webhook\", \"third-party API\", \"external service\", \"API client\", \"integrate with\", \"signature verification\", \"idempotency key\".

    Also in 3 projects that use this

The file

Create a free account to mount
Files
SKILL.md

/api-design — Thiết kế Hợp đồng API Tích hợp 🌟 [CORE WORKFLOW]

Bản thiết kế tích hợp: các hệ thống phối hợp thế nào

Mục tiêu

Cung cấp hướng dẫn chuyên gia BA để thực thi lệnh /api-design, sinh ra tài liệu chất lượng cao, có thể đưa vào sản xuất ngay lập tức mà không cần chỉnh sửa lại format.

Quy chuẩn bắt buộc tuân thủ (Rules)

  • rules/10-api-contract-standards.md\n- rules/03-err-naming-convention.md

Biểu mẫu tham chiếu (Template)

  • _templates/37-api-design.md

Vị trí lưu tệp mặc định

  • docs/{feature}/api/api-spec.md

Workflow thực hiện

  1. Thiết kế danh mục Endpoints RESTful theo Rule 10.
  2. Đặc tả Request Headers, Request Body, Response 200 OK, Response Error (400, 401, 404, 422, 500).
  3. Định nghĩa cơ chế Webhook / Callback và quy tắc xác thực chữ ký (Signature verification).
  4. Lưu vào docs/{feature}/api/api-spec.md.

Tiêu chí Nghiệm thu (Quality Checklist)

  • Sử dụng ngôn ngữ tiếng Việt chuyên nghiệp, đúng thuật ngữ IT BA.
  • Không chứa các từ ngữ mơ hồ định tính (Rule 16).
  • Tuân thủ quy ước đặt mã chuẩn (FR/BR/ERR/UC/US).
  • Lưu đúng vị trí tệp quy định trong dự án.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free