skills.rest
acardozzo
acardozzoCOMMUNITY
Explore all skills by this author →
GitHub

api-rx

Evaluate REST API surface design across 8 metric-driven dimensions.

Updated Mar 15, 2026
Search Tags:#api#rest#developer experience#design review#quality evaluation#scorecard
One-click install
npx skills add https://github.com/acardozzo/rx-suite --skill api-rx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-rx
Source: https://github.com/acardozzo/rx-suite/tree/main/skills/api-rx
Command: npx skills add https://github.com/acardozzo/rx-suite --skill api-rx

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill evaluates the quality of your API surface design from a consumer's perspective, identifying specific areas for improvement to achieve a world-class developer experience.

Core Features & Use Cases

  • Metric-Driven Evaluation: Scores APIs against 8 dimensions and 32 sub-metrics with exact thresholds.
  • Actionable Prescriptions: Provides detailed recommendations and improvement plans.
  • Use Case: You've just launched a new REST API and want to ensure it's intuitive, consistent, and easy for developers to integrate with. Run api-rx to get a comprehensive audit and a roadmap to A+ quality.

Quick Start

Use the api-rx skill to evaluate the API surface in the 'src/api' directory.

Frequently Asked Questions about api-rx

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

FAQPage Schema
How do I evaluate REST API design quality and developer experience?▼

Evaluate REST API design quality by scoring the API surface against 8 dimensions, including resource design, response consistency, and authentication. This process identifies specific DX gaps and generates actionable prescriptions based on industry standards.

What metrics are used to grade REST API developer experience?▼

REST API developer experience is graded using 32 sub-metrics across 8 dimensions, covering SDK readiness, webhooks, performance, and documentation. These exact thresholds generate a comprehensive scorecard for measuring API quality.

How do I audit my REST API against OpenAPI and Richardson Maturity Model standards?▼

Audit your REST API by analyzing its surface design against industry standards like Richardson Maturity Model, JSON:API, and OpenAPI 3.1. The evaluation identifies inconsistencies and generates an improvement plan to achieve A+ quality.

Can I assess API versioning and webhook readiness using an automated scorecard?▼

Yes, you can assess API versioning and webhook readiness through a metric-driven scorecard. It evaluates these specific dimensions alongside authentication and response consistency to provide targeted prescriptions for improvement.

What is the best way to identify gaps in REST API resource design and documentation?▼

The best way to identify gaps in REST API resource design and documentation is to run a metric-driven evaluation across 8 dimensions. This generates a detailed scorecard with actionable prescriptions highlighting specific areas needing improvement.

Related Skills

Explore More Software Engineering Skills→
belokonmbelokonm
8

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
billh93billh93

openapi-spec-generation

Generate OpenAPI 3.1 specifications from code and design patterns.

Community
Advanced
mahg-esmahg-es
3

api-design

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Official
Advanced
mrsorbatemrsorbate

github-code-review

Analyze GitHub pull requests with a swarm of specialized AI agents.

Community
Advanced