Skip to main content

Bundles/saas-api-design

API Design Audit

saas-api-design · v1.1.0 · paid

API design quality assessment covering naming consistency, HTTP semantics, request/response shape, security controls, and developer experience.

API Consistency

api-consistency · weight 0.25

Consistent API naming convention
ab-002167
high
HTTP methods used correctly
ab-002169
high
Consistent response envelope format
ab-002166
medium
API versioning strategy defined
ab-002165
medium

Request/Response Design

request-response · weight 0.25

Pagination on list endpoints
ab-002168
high
Filtering and sorting supported where appropriate
ab-002201
low
No unnecessary data in responses (over-fetching)
ab-002200
low
Request body size limits configured
ab-002199
medium
Bulk operations available where needed
ab-002202
low

API Security

api-security · weight 0.25

Rate limiting implemented
ab-002204
critical
Input validation on all endpoints
ab-002203
critical
Authentication required on non-public endpoints
ab-002195
critical
CORS properly configured
ab-002194
high
File upload endpoints have size and type restrictions
ab-002197
high
Idempotency keys for payment and mutation endpoints
ab-002198
high
Webhook endpoints validate payloads
ab-002193
medium
GraphQL query depth and complexity limits
ab-002196
high

Documentation & DX

api-docs · weight 0.25

Error responses include codes and messages
ab-002214
high
API responses include appropriate cache headers
ab-002212
low
OpenAPI / Swagger documentation exists
ab-002213
low
API timeout handling configured
ab-002211
low
API deprecation strategy defined
ab-002215
low