api-design

Designs Elixir/BEAM APIs with architecture, versioning, and documentation guidance.

1|1|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/layeddie/ai-rules --skill api-design-layeddie
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/layeddie/ai-rules/tree/main/skills/api-design
Command: npx skills add https://github.com/layeddie/ai-rules --skill api-design-layeddie

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design robust Elixir/BEAM APIs by guiding architecture choices (REST vs GraphQL), versioning strategies, rate limiting, and documentation approaches.

Core Features & Use Cases

  • Architecture guidance for REST and GraphQL based APIs in Elixir/BEAM projects, with versioning and documentation considerations.
  • Best-practice patterns for rate limiting, pagination, and authentication integration across API surfaces.
  • Suitable for teams delivering public or internal Elixir services that require clear API contracts and evolvable interfaces.

Quick Start

Command your AI to draft an API design plan that selects between REST and GraphQL, outlines versioning, and documents the endpoints for a new Elixir/BEAM service.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST and GraphQL APIs in Elixir with proper versioning?

Design robust Elixir APIs by selecting REST or GraphQL architectures. It enforces versioned routing, authentication considerations, and integrates OpenAPI or Absinthe to maintain consistent documentation across BEAM services.

What is the best way to document Elixir API endpoints?

Document Elixir API endpoints by integrating OpenAPI or Absinthe. This enforces comprehensive documentation practices, ensuring clear API contracts and evolvable interfaces for internal or public Elixir services.

How do I set up rate limiting and pagination for Elixir/BEAM services?

Apply best-practice patterns for rate limiting and pagination across Elixir API surfaces. The skill guides ramping rate limits and pagination strategies to ensure robust and evolvable API interfaces.

Should I choose REST or GraphQL for my Elixir API project?

Choose REST or GraphQL for Elixir APIs based on architecture needs. The skill provides guidance contrasting both approaches to help teams select the appropriate design for clear API contracts and evolvable interfaces.

Can I use this to plan authentication integration for Elixir APIs?

Yes, plan authentication integration for Elixir APIs using this skill. It enforces authentication considerations alongside versioned routing and rate limiting to deliver robust public or internal Elixir/BEAM services.

Does this approach work for internal Elixir services or only public APIs?

This approach works for both internal and public Elixir services. It suits teams delivering services requiring clear API contracts, evolvable interfaces, and consistent documentation regardless of exposure level.