🧩
AI EngineeringPython

Api Design Safety

by doccker

Api Design Safety is an AI Engineering skill for Claude Code, published by doccker in cc-use-exp.

1K stars105 forkson doccker/cc-use-expAdded 2026/08/21Repository updated 2026/06/30
antigravityclaude-codecodexcursorgemini-cligithub-copilot
Install in seconds
Install Api Design Safety
Copy Api Design Safety into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.
terminal
npx degit https://github.com/doccker/cc-use-exp/tree/main/skills/api-design-safety ~/.claude/skills/api-design-safety

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/doccker/cc-use-exp.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file
skills/api-design-safety/SKILL.md in doccker/cc-use-exp
Installs to
~/.claude/skills/api-design-safety
Collection
One of 23 skills cataloged from this repository
Category
AI Engineering2451 skills

What Api Design Safety does

Api Design Safety helps prevent REST API response design mistakes such as field mix-ups, ambiguous return types, and inconsistent empty values. Use it when designing or changing API responses and handling returned data.

Api Design Safety is cataloged under AI Engineering on DirSkills. Api Design Safety comes from a repository tagged antigravity, claude-code, codex, cursor and gemini-cli.

Documentation

README

API 设计安全规范

当设计或修改 REST API 响应结构时,防止常见的设计缺陷。


陷阱 #1: 泛型方法重载歧义

场景: 返回类型为 String 时,Java 重载解析可能匹配错误的方法

问题根因

Java 方法重载解析时,String 类型参数会优先匹配 success(String message) 而非 success(T data),导致数据进入错误的字段。

错误示例

// ApiResponse 有两个重载:
public static <T> ApiResponse<T> success(T data)
public static <T> ApiResponse<T> success(String message, T data)

// ❌ 错误: String 类型匹配到 success(String message)
String avatarUrl = "http://example.com/avatar.jpg";
return ApiResponse.success(avatarUrl);
// 结果: {"code":200, "message":"http://...", "data":null}
// 前端 data.data 拿到 null,导致功能异常

正确做法

This is the opening of the README. Read the full README on GitHub.

Frequently asked about Api Design Safety

  • What else does doccker publish alongside Api Design Safety?

    Api Design Safety is one of 23 skills that DirSkills catalogs from doccker/cc-use-exp, the repository it ships in. Its siblings there include API Design Safety, Api Proxy Safety and Async Task Pattern. Each one is a separate skill with its own page in this directory, installs the same way Api Design Safety does, and is maintained by doccker in that same repository. The rest of the collection is listed on the doccker/cc-use-exp page.

  • How does Api Design Safety compare to other AI Engineering skills?

    Api Design Safety ranks #1372 by stars among the 2451 AI Engineering skills in this catalog. The most-starred ones next to it are Architecture Decision Records, AI-First Engineering and Agentic OS. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of Api Design Safety against them. Open each page to compare what they document and how they install.

More from doccker/cc-use-exp

Api Design Safety is one of 23 skills cataloged on DirSkills from doccker/cc-use-exp.

See all 23 skills
🛡️
1w ago

API Design Safety

API Design Safety helps you design REST API responses and generated outputs with consistent field semantics, null handling, and status codes. It also checks required fields before exporting files or sending downstream payloads to avoid silent failures.
Quality
1K105
🛡️
1w ago

Api Proxy Safety

Api Proxy Safety defines safe keyword matching for gateways, proxies, WAFs, and CDNs so normal content is not misclassified as an error. It is used when implementing heuristic checks for response bodies, status codes, and error schemas.
DevOps
1K105
1w ago

Async Task Pattern

Async Task Pattern provides a standard triggerAsync/getStatus flow for operations that may run longer than 10 seconds. Use it for batch processing, remote API fan-out, or scans that would otherwise time out or be triggered twice.
Automation
1K105
🐚
1w ago

Bash Style

Bash Style provides shell scripting and command-writing conventions for .sh files, Dockerfiles, Makefiles, YAML, and Markdown bash blocks. Use it to format commands, heredocs, file writes, permissions, and script safety.
Writing
1K105
🧩
1w ago

Code Quality Principles

Code Quality Principles provides a checklist for modular design, refactoring, and code review. Use it to assess module size, call depth, fan-in/fan-out, boundaries, scope cohesion, and predictability.
Quality
1K105
🧪
1w ago

External System Debugging

External System Debugging helps debug code that depends on browsers, editors, CDNs/WAFs, IM platforms, clipboards, or third-party SaaS. It requires collecting real environment data first, then using that evidence to diagnose paste, rendering, API, and cross-platform issues.
Quality
1K105