skills.rest
BRANDNEWSHVT
BRANDNEWSHVTOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-design-audit

Audit API designs for contracts, error handling, and documentation standards.

Updated Aug 20, 2025
Search Tags:#design#versioning#documentation#api#audit#rest#graphql
One-click install
npx skills add https://github.com/BRANDNEWSHVT/mercora --skill api-design-audit-brandnewshvt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-audit
Source: https://github.com/BRANDNEWSHVT/mercora/tree/main/storefront-nuxt/.agents/skills/api-design-audit
Command: npx skills add https://github.com/BRANDNEWSHVT/mercora --skill api-design-audit-brandnewshvt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps API teams ensure contracts are clear, stable, and well-documented, preventing breaking changes and misaligned expectations across consumers.

Core Features & Use Cases

  • Covers endpoint design, request/response contracts, versioning, error handling, pagination, rate limiting, and documentation.
  • Use cases include designing new APIs, reviewing existing architectures, and auditing API governance and compliance.

Quick Start

Provide a practical API design audit for a new or existing API by evaluating endpoint contracts, errors, pagination, versioning, and documentation.

Frequently Asked Questions about api-design-audit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I audit an API design for consistent contracts and error handling?▼

To audit an API design, you evaluate endpoint contracts, enforce REST conventions, and check error structuring, validation, pagination, and versioning to ensure clear, stable, and well-documented APIs.

What is API design governance and when do I need to validate API behavior?▼

API design governance is the process of enforcing REST conventions, error structuring, and documentation standards. You need to validate API behavior when designing new endpoints or reviewing existing architectures to prevent breaking changes.

Does this API audit cover both REST and GraphQL versioning standards?▼

Yes, the API audit validates behavior against governance rules by enforcing REST conventions, GraphQL standards, versioning, pagination, and documentation to ensure robust and consistent API architectures.

What is the best way to prevent breaking changes in existing API architectures?▼

The best way to prevent breaking changes is to conduct an API design audit that evaluates endpoint contracts, enforces versioning standards, and validates error handling against established governance rules.

How do I structure API pagination and rate limiting during an architecture review?▼

To structure API pagination and rate limiting during a review, you audit the existing API designs against governance rules to ensure robust error handling and consistent documentation standards are applied.

Related Skills

Explore More Software Engineering Skills→
k1lgork1lgor
2

api-designer

Standardize REST and GraphQL API designs with routes, schemas, and OpenAPI specifications.

Community
Intermediate
noartemnoartem

laravel-api-resources-and-pagination

Shape Laravel models into versioned, paginated API responses with conditional fields.

Community
Intermediate
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
s3nex-coms3nex-com

api-contract-enforcer

Verify service implementations against OpenAPI specs using Pact or Schema Registry.

Community
Advanced