api-standards

Enforce resource-oriented API design and transport-specific conventions for gRPC, REST, and MVC contracts.

2|Updated May 18, 2022

Search Tags:#design #api #compatibility #rest #contract #grpc

Ready to run

npx skills add https://github.com/alexfalkowski/bin --skill api-standards-alexfalkowski

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-standards
Source: https://github.com/alexfalkowski/bin/tree/main/skills/api-standards
Command: npx skills add https://github.com/alexfalkowski/bin --skill api-standards-alexfalkowski

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the complexity of maintaining long-lived API contracts by providing a standardized framework for design, review, and evolution, preventing inconsistent naming, transport-specific shortcuts, and breaking changes.

Core Features & Use Cases

API Design Guidance: Enforces Google Cloud API Design Guide and AIP standards for resource-oriented architecture.
Transport-Specific Logic: Provides specialized rules for net/http/rpc, net/http/rest, and net/http/mvc transport contracts.
Compatibility Guardrails: Ensures that changes to schemas, routes, or methods do not break existing clients or generated artifacts.

Quick Start

Use the api-standards skill to review the proposed changes to the user service endpoint and verify compliance with the net/http/rest transport contract.

Frequently Asked Questions about api-standards

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

FAQPage Schema

How do I ensure backward compatibility when modifying a gRPC or REST API contract?▼

To ensure backward compatibility when modifying an API contract, apply standardized review frameworks that enforce resource-oriented principles and prevent breaking changes to existing schemas, routes, or generated artifacts.

What standards should I follow for resource-oriented API design?▼

Resource-oriented API design should follow the Google Cloud API Design Guide and AIP standards to enforce architectural consistency, standardized naming, and robust transport-specific conventions across service surfaces.

How do I review API changes for net/http/rest and net/http/mvc transport contracts?▼

Reviewing API changes for transport contracts requires applying specialized rules for net/http/rpc, net/http/rest, and net/http/mvc surfaces to verify compliance with local repository conventions and ensure architectural consistency.

Does this API standardization approach work for both gRPC and MVC service surfaces?▼

Yes, API standardization applies to gRPC, REST, and MVC service surfaces during development, refactoring, or compatibility assessment, requiring adherence to transport-specific conventions to maintain architectural consistency across different protocols.