Skip to main content

Stack Scan Audits Catalog Pricing Docs Scrab

Bundles/api-design

API Design Audit

api-design · v1.1.1 · paid

Evaluates API design quality — naming conventions, schema contracts, versioning strategy, and developer ergonomics for REST, GraphQL, and gRPC APIs.

Naming Conventions

naming-conventions · weight 0.25

Resource naming follows REST conventions
ab-000352
high
Consistent field naming convention
ab-000353
high
Enum values use consistent format
ab-000354
medium
Query parameter naming is consistent
ab-000355
medium
URL segments use one casing style
ab-000356
high
Boolean fields use descriptive prefixes
ab-000357
low

Contract & Schema Quality

contract-quality · weight 0.3

API schema definition exists
ab-000358
critical
Schema matches implementation
ab-000359
critical
Request bodies validated against schema
ab-000360
high
Response objects are typed
ab-000361
high
Nullable fields explicitly marked
ab-000362
medium
Pagination pattern defined and consistent
ab-000363
high
Error responses follow one structure
ab-000364
critical

Versioning & Evolution

versioning-evolution · weight 0.25

API versioning strategy exists
ab-000365
critical
Breaking change policy documented
ab-000366
high
Deprecated endpoints/fields marked
ab-000367
medium
API changelog maintained
ab-000368
low
New fields are additive with defaults
ab-000369
high

Developer Ergonomics

developer-ergonomics · weight 0.2

HTTP status codes used consistently
ab-000370
high
Sort/filter fields documented
ab-000371
medium
Idempotent operations and idempotency keys
ab-000372
high
Batch endpoints avoid N+1 client calls
ab-000373
low
Responses include related resource links
ab-000374
info
Empty collections return empty array
ab-000375
low

The AI Slop Detector. Find out what your AI got wrong before your users do.

We catch the slop.

Product

Stack Scan
Audits
Catalog
Bundles
Taxons
Packs
Pricing

Learn

Docs
Visual Guide
Benchmarks
Demo
Blog
Scrab

Connect

About
Contact
X (Twitter)
Privacy
Your Privacy Choices
Terms

© 2026 AuditBuffet · Built for the people shipping scary-fast.

Free Stack Scan · Pro from $9/mo