skills.rest
martinholovsky
martinholovskyCOMMUNITY
Explore all skills by this author →
𝕏@martinholovskyGitHub

sota-api-design

Audit and design APIs using 2026 practices for REST, GraphQL, gRPC, and webhooks.

12|2|Updated Jun 17, 2026
Search Tags:#api design#rest#graphql#webhooks#gRPC#api audit
One-click install
npx skills add https://github.com/martinholovsky/SOTA-skills --skill sota-api-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: sota-api-design
Source: https://github.com/martinholovsky/SOTA-skills/tree/main/skills/sota-api-design
Command: npx skills add https://github.com/martinholovsky/SOTA-skills --skill sota-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides expert-level rules and guidance for designing and auditing APIs, addressing concerns like security, operations, and evolvability.

Core Features & Use Cases

  • API Design: Offers comprehensive rules for API design, including protocol selection, contract first approach, versioning, and security considerations.
  • API Audit: Provides audit checklists for reviewing existing APIs to ensure correctness, evolvability, security, and operational robustness.
  • Use Case: If you are developing an API for a web service, this Skill can help you design it securely and efficiently, ensuring it can evolve over time.

Quick Start

Load the relevant rules for the specific API you are designing or auditing using the provided guidelines.

Frequently Asked Questions about sota-api-design

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

FAQPage Schema
How do I design an API using contract-first principles for REST and gRPC?▼

API design using a contract-first approach involves defining protocol selection, versioning rules, and security considerations before implementation. This Skill provides comprehensive rules for designing REST, gRPC, GraphQL, and webhook APIs securely.

What is the best way to audit an existing REST API for security and evolvability?▼

Auditing an existing REST API requires checklists that validate correctness, evolvability, security, and operational robustness. This Skill provides audit checklists to review APIs against state-of-the-art 2026 practices.

When should I use webhooks versus WebSockets and SSE for my API?▼

Choosing between webhooks, WebSockets, and SSE depends on your API's real-time communication requirements and operational constraints. This Skill offers protocol selection guidelines to determine the appropriate mechanism for your use case.

Do I need prior knowledge of API security principles to use these design guidelines?▼

Yes, you need existing knowledge of API design principles and security considerations. This Skill provides expert-level rules and guidance for designing and auditing APIs, assuming a foundation in security and evolvability.

How do I ensure my GraphQL API can evolve without breaking existing clients?▼

Ensuring GraphQL API evolvability requires applying specific versioning strategies and contract-first design rules. This Skill focuses on evolvability alongside security and operations to help your API adapt over time.

What are the limitations of applying 2026 API practices to legacy web service integrations?▼

Legacy web service integrations may lack native support for modern contract-first approaches or advanced protocol features. This Skill focuses on state-of-the-art 2026 practices, which may require significant refactoring to align older systems.

Related Skills

Explore More Software Engineering Skills→
davidrrowleydavidrrowley

api-design

Design and validate REST, GraphQL, and gRPC API contracts with OpenAPI schemas.

Community
Advanced
mariotoffiamariotoffia

setup-contract-tests

Automate contract testing setup for microservices using OpenAPI and JSON Schema.

Community
Advanced
passionseedpassionseed
2

ai-gateway

Route LLM API calls through a unified TrueFoundry AI Gateway.

Official
Advanced
vinaykumarvkvinaykumarvk
1

coding-standards-review

Scan codebases for security flaws, quality issues, and accessibility violations.

Community
Advanced