api-conventions
Skill1 starsChanged 3 months agoApache-2.0View on GitHub
API Conventions for structure, comments, requests, and responses.
16 other projects use a version of this.
Adopted by
Most recently taken up by
- LeanMeanCleanApps/CleanLambdaFunctiontheir own version, first seen Nov 15, 2026
- LeanMeanCleanApps/CleanWebApitheir own version, first seen Nov 15, 2026
- LeanMeanCleanApps/CleanGraphQLApitheir own version, first seen Nov 15, 2026
- LeanMeanCleanApps/CleanMinimalApitheir own version, first seen Nov 15, 2026
- leroyguillaume/claudetheir own version, first seen Nov 15, 2026
- willdady/platypustheir own version, first seen Nov 15, 2026
Other versions16 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 16
- mx-space/core★ 567same name
- LeanMeanCleanApps/CleanMinimalApi★ 400same name
- TheDecipherist/claude-code-mastery-project-starter-kit★ 337same name
- willdady/platypus★ 130same name
- maxyeh0817/Forge★ 34same name
- LeanMeanCleanApps/CleanGraphQLApi★ 13same name
- harness-studio/harness-studio★ 9same name
- leroyguillaume/claude★ 7same name
- LeanMeanCleanApps/CleanWebApi★ 4same name
- CodeWithBehnam/cc-docs★ 2same name
6 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository12 other files it gives its agents.
- csharp-styleSkill
- database-conventionsSkill
- default-gitignore-filesSkill
- fusion-360-addinSkill
- git-workflowSkill
- godot-game-engineSkill
- logging-conventionsSkill
- npm-registrySkill
- postgres-styleSkill
- python-styleSkill
- typescript-styleSkill
- ui-designSkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 7 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 12 edited versions we read keep these.
7
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
- Distinctive: line 10
Prefer specific HTTP Response Codes(e.g.
- Distinctive: line 13
If Security is a concern, develop a table for Developers that have anonymized Error Codes(i.e.
- Distinctive: line 16
If a language supports shared libraries, these DTO and/or Interfaces should be in a shared library that is easily accessible by projects …
- Distinctive: line 17
Follow standard REST style URLs unless otherwise specified(i.e.
- Distinctive: line 18
Prefer JSON encoding for Request bodies for POST, PUT, PATCH, etc.
- Distinctive: line 19
Prefer JSON for Response bodies where supported
- Distinctive: line 23
Use OpenAPI(aka Swagger) for documenting API endpoints and related resources(e.g.
“Common” is measured: kept by at least 6 in 10 of the 12 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.
Files
API Conventions
General
- Prefer specific HTTP Response Codes(e.g. 400) over generic Codes wherever available(e.g 500)
- See STATUS CODES for more examples.
- Error Responses should include specific errors for troubleshooting purposes rather than generic messages.
- If Security is a concern, develop a table for Developers that have anonymized Error Codes(i.e. 1001) along with how to locate and/or diagnose the issue. In such case, return the anonymized code(e.g. 1001) in the HTTP Response.
- Requests and Responses should follow a standard format across the entire API.
- Development and use of specific DTO or Interfaces(where available) for each Endpoint is preferred.
- If a language supports shared libraries, these DTO and/or Interfaces should be in a shared library that is easily accessible by projects accessing the API(e.g. frontend, mobile app, etc.)
- Follow standard REST style URLs unless otherwise specified(i.e. POST for INSERT, PUT for UPDATE, DELETE for delete, etc.)
- Prefer JSON encoding for Request bodies for POST, PUT, PATCH, etc.
- Prefer JSON for Response bodies where supported
TypeScript
- Use OpenAPI(aka Swagger) for documenting API endpoints and related resources(e.g. DTO)
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
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.

