Skip to content
Back to skills

Api Design

ASecurity

Design small explicit APIs with stable contracts and useful errors.

  • 3 stars
  • 0 votes
  • 0 copies
  • 2 views
  • Added September 3, 2026
developmentapi

Works with

  • api

Security analysis

A100/100

Scanned September 3, 2026

npx -y skills add Andersseen/agentyx --skill api-design --agent claude-code

Installs into .claude/skills of the current project.

Are you the author of Api Design?

Add the live security badge to your README. It updates with every re-scan.

Security grade badge for Api Design
[![Security: A — Skills Directory](https://www.skillsdirectory.com/api/skills/andersseen-api-design/badge)](https://www.skillsdirectory.com/skills/andersseen-api-design)

More formats (shields.io, HTML) on the badges page. Keep it an A: scan every change in CI with Pro.

Download with Pro
SKILL.md
---
name: api-design
description: Design small explicit APIs with stable contracts and useful errors.
---

# API design

Treat every public function, command flag, file format, and exported type as a contract.

## Surface

Expose the smallest surface that solves the current need. Keep helpers private until a real caller
appears. Avoid making implementation details part of the contract.

## Behavior

Make inputs, outputs, ordering, defaults, and failure modes predictable. If behavior is conditional,
name the condition directly instead of hiding it behind a vague option.

## Compatibility

When changing an existing contract, look for callers, tests, generated artifacts, and docs. Decide
whether compatibility matters for the version you are working on, then migrate the whole surface
consistently.

## Errors

Errors are part of the API. Give expected failures stable types or codes, clear messages, and enough
context for the caller to recover.

Attribution

Is this your skill, or is something wrong with this listing? Request removal or report an issue. Author removals are honored within 72 hours.

Comments

Loading comments…