CtrlK
BlogDocsLog inGet started
Tessl Logo

tessl-labs/api-design-patterns

REST API design patterns — response envelopes, pagination, filtering, status codes, and resource naming

87

1.78x
Quality

83%

Does it follow best practices?

Impact

98%

1.78x

Average score across 4 eval scenarios

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

resource-naming.jsonverifiers/

{
  "instruction": "Follow RESTful resource naming conventions",
  "relevant_when": "Agent creates or modifies REST API route definitions",
  "context": "Consistent resource naming makes APIs predictable. URLs use plural nouns, HTTP methods convey actions, and nested resources express parent-child relationships.",
  "sources": [
    {
      "type": "file",
      "filename": "skills/api-design-patterns/SKILL.md",
      "tile": "tessl-labs/api-design-patterns@0.1.0"
    }
  ],
  "checklist": [
    {
      "name": "plural-nouns",
      "rule": "Resource URLs use plural nouns (e.g., /products, /orders, /users), not singular",
      "relevant_when": "Agent defines API route paths"
    },
    {
      "name": "no-verbs-in-urls",
      "rule": "URLs do not contain verbs like /createProduct, /getUsers, /deleteOrder — the HTTP method is the verb",
      "relevant_when": "Agent defines API route paths"
    },
    {
      "name": "nested-resources-max-one-level",
      "rule": "Nested resources are at most one level deep (e.g., /customers/:id/orders is fine, but /customers/:id/orders/:orderId/items/:itemId/reviews is too deep)",
      "relevant_when": "Agent defines nested API routes"
    }
  ]
}

tile.json