Name: tessl-labs/api-design-patterns
Rating: 87.5 (1 reviews)
Author: tessl-labs

Blog Docs Log in Get started

tessl-labs/api-design-patterns

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

1.78x

Quality

83%

Does it follow best practices?

Impact

98%

1.78x

Average score across 4 eval scenarios

Securityby

Passed

No known issues

Evaluation results

100%

57%

Inventory Management API for a Warehouse System

Criteria

Without context

With context

success-response-envelope

100%

error-response-envelope

25%

100%

list-endpoint-paginated

100%

filtering-support

100%

plural-noun-resource-paths

50%

100%

201-for-creation

62%

100%

bulk-receiving-endpoint

100%

bulk-max-size

100%

bulk-per-item-results

66%

100%

transfer-validation

50%

100%

404-for-not-found

66%

100%

pagination-metadata

100%

safe-defaults

100%

validation-error-status

66%

100%

97%

37%

Order API for a Customer Portal

Criteria

Without context

With context

success-response-envelope

100%

error-response-envelope

25%

100%

nested-resource-for-customer-orders

100%

plural-noun-resource-paths

50%

66%

list-endpoint-paginated

100%

filtering-by-status

100%

201-for-order-creation

100%

order-includes-line-items

100%

patch-shipping-address

100%

cancel-status-validation

100%

batch-status-update

100%

batch-max-size

100%

404-for-not-found

100%

204-for-delete-or-cancel

100%

44%

Product Catalog API for an E-Commerce Platform

Criteria

Without context

With context

success-response-envelope

100%

error-response-envelope

30%

100%

list-endpoint-paginated

100%

pagination-metadata

100%

default-and-max-limit

100%

filtering-support

100%

201-for-post

100%

204-for-delete

100%

404-for-not-found

100%

plural-noun-resource-path

100%

patch-partial-update

100%

patch-returns-full-resource

100%

validation-error-status

80%

100%

97%

34%

User Management API for an Admin Dashboard

Criteria

Without context

With context

success-response-envelope

100%

error-response-envelope

100%

list-endpoint-paginated

100%

filtering-by-role-and-status

100%

sorting-support

100%

search-support

100%

201-for-post

100%

409-for-duplicate-email

100%

patch-partial-update

100%

plural-noun-resource-path

100%

deactivate-not-delete

33%

50%

404-for-not-found

100%

safe-defaults

16%

100%

Evaluated: 17 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Inventory Management API for a Warehouse System Order API for a Customer Portal Product Catalog API for an E-Commerce Platform User Management API for an Admin Dashboard