agentleFS
FAHTHIZFAHTHIZ/oasis/skills/api-development/SKILL.md

api-development

Skill4 starsChanged 9 days agoApache-2.0View on GitHub

Design and implement validated, authenticated APIs with clear error contracts and safe lifecycle handling.

11 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use git-workflow.

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.
  • Microsoft AzureSkill

    git-workflow

    Squad branching model: dev-first workflow with insiders preview channel

    Also in 4 projects that use this

The file

We split this skill into the rules it gives an agent

5 rules. 0 are common, 5 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the existing API conventions and call sites before adding routes, dependencies, or new abstractions.

    line 8
  2. Distinctive:

    Use explicit authentication and authorization.

    line 10
  3. Distinctive:

    Use parameterized/argv-based process execution rather than shell interpolation.

    line 13
  4. Distinctive:

    Test unauthenticated, malformed, oversized, cross-origin, duplicate, timeout, and error-path behavior using temporary resources and mocked …

    line 14
  5. Distinctive:

    Document the trust boundary, deployment assumptions, and any remaining rate-limit, transport-encryption, or sandbox limitations.

    line 15

“Common” is measured: kept by at least 6 in 10 of the 10 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

API development skill

  1. Read the existing API conventions and call sites before adding routes, dependencies, or new abstractions.
  2. Validate HTTP method, path parameters, request content type, body size, object shape, field types, and allowed values before performing side effects.
  3. Use explicit authentication and authorization. Treat CORS and same-origin checks as defense-in-depth, not substitutes for authentication.
  4. Return consistent status codes and bounded error messages; do not leak API keys, environment variables, stack traces, or internal filesystem details.
  5. Bound concurrent work, request duration, output/event history, and resource cleanup. Make retries and duplicate submissions safe where practical.
  6. Use parameterized/argv-based process execution rather than shell interpolation. Require approval for consequential side effects and explain what approval permits.
  7. Test unauthenticated, malformed, oversized, cross-origin, duplicate, timeout, and error-path behavior using temporary resources and mocked external services.
  8. Document the trust boundary, deployment assumptions, and any remaining rate-limit, transport-encryption, or sandbox limitations.

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.