skills.rest
flutter
flutterOFFICIAL
Explore all skills by this author →
Website𝕏@FlutterDevGitHub

api-review

Review source code against canonical API design principles.

2.8k|166|Updated Feb 25, 2026
Search Tags:#architecture#refactoring#api#best-practices#design-principles#code-review
One-click install
npx skills add https://github.com/flutter/agent-plugins --skill api-review-flutter
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-review
Source: https://github.com/flutter/agent-plugins/tree/main/.agents/agents/reidbaker-agent/skills/api-review
Command: npx skills add https://github.com/flutter/agent-plugins --skill api-review-flutter

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the challenge of maintaining consistent, high-quality API design across a codebase by automating the evaluation of code against established architectural principles.

Core Features & Use Cases

  • Canonical Analysis: Evaluates code against the Foundations of Canonical API Design Principles, including contract-first design, KISS, and YAGNI.
  • Structured Reporting: Generates a comprehensive report with letter grades, critical issues, and actionable code improvements.
  • Use Case: Use this skill when refactoring a public-facing library or service to ensure the interface remains ergonomic, predictable, and decoupled from implementation details.

Quick Start

Use the api-review skill to analyze the current file against the canonical API design guidelines.

Frequently Asked Questions about api-review

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

FAQPage Schema
What is canonical API design and how does it improve code reviews?▼

Canonical API design evaluates source code against contract-first, KISS, and YAGNI principles to ensure architectural consistency and interface ergonomics during code reviews. It generates a structured report with letter grades and actionable improvements to maintain code quality.

How do I review my source code against API design principles?▼

You can review source code against API design principles by applying automated evaluation to check for contract-first design, KISS, and YAGNI adherence. This process outputs a comprehensive report highlighting critical issues and actionable code improvements for architectural consistency.

When do I need to use canonical API design principles for refactoring?▼

You need canonical API design principles when refactoring a public-facing library or service to ensure the interface remains ergonomic, predictable, and decoupled from implementation details. It validates architectural consistency and prevents interface degradation during structural changes.

Does API refactoring require contract-first design and YAGNI principles?▼

Yes, API refactoring requires adherence to contract-first design, KISS, and YAGNI principles to maintain interface ergonomics and architectural consistency. These canonical design principles ensure the refactored code remains predictable and decoupled from implementation details.

What's the best way to validate architectural consistency in a public-facing library?▼

The best way to validate architectural consistency is by evaluating code against canonical API design guidelines using contract-first and KISS principles. This approach generates a structured report with letter grades and critical issues, ensuring the public interface remains ergonomic and decoupled.

Related Skills

Explore More Software Engineering Skills→
ylxmf2005ylxmf2005
11

solution-architect

Document architectural decisions and interface contracts in design/architecture.md.

Community
Advanced
hs3180hs3180
3

reporter

Format user feedback and deliver report files via platform tools.

Community
Intermediate
lucascarolucascaro

gc-sweep

Detect and correct code deviations against golden-principle guidelines in repositories.

Community
Intermediate
insightwavesmithinsightwavesmith

code-analyzer

Analyze code changes to identify those meeting evidence-shape-check criteria.

Community
Intermediate