api-forge

Design REST and GraphQL APIs with OpenAPI 3.1 specifications and operational details.

110|14|Updated May 12, 2026
One-click install
npx skills add https://github.com/EliasOulkadi/shokunin --skill api-forge
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-forge
Source: https://github.com/EliasOulkadi/shokunin/tree/main/.pack/skills/api-forge
Command: npx skills add https://github.com/EliasOulkadi/shokunin --skill api-forge

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of designing consistent, reliable HTTP APIs by turning product requirements into a complete API contract with predictable behavior for errors, pagination, rate limiting, webhooks, and idempotency.

Core Features & Use Cases

  • OpenAPI 3.1-first API design: Generate an OpenAPI 3.1 spec with endpoint summaries, parameters, request bodies, and fully enumerated responses.
  • Production-grade HTTP semantics: Enforce correct method usage, consistent status code-to-code mappings, and envelope-style responses that include request correlation.
  • Real-world operational concerns: Add cursor-based pagination, token-bucket rate limiting, webhook retry + HMAC signature verification, and idempotency for create/update actions (Stripe-style patterns).

Example use case: you need an API for an orders system with secure endpoints, cursor pagination for public listing, webhook notifications for order.created, and safe POST behavior using Idempotency-Key.

Quick Start

Ask the AI to design a REST API with cursor pagination, standardized error envelopes, rate limiting headers, webhook delivery with HMAC-SHA256 verification, and Idempotency-Key support for POST create endpoints.

Frequently Asked Questions about api-forge

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

FAQPage Schema
How do I design a REST API with OpenAPI 3.1 specifications and standardized error envelopes?

Designing a REST API with OpenAPI 3.1 involves generating specifications with endpoint summaries, parameters, and structured error envelopes containing request_id and code mappings for predictable HTTP behavior. This process ensures consistent status-code mapping and fully enumerated responses across all endpoints.

What is the best way to implement cursor-based pagination and rate limiting in an API?

Implementing cursor-based pagination and rate limiting requires defining operational design details with cursor constraints and token-bucket rate limiting tiers within your API contract. This approach enforces production-grade HTTP semantics and manages data retrieval efficiently for public listing endpoints.

How do I add webhook delivery with HMAC-SHA256 signature verification to my API design?

Adding webhook delivery with HMAC-SHA256 signature verification to an API design entails specifying webhook retry mechanisms and signature validation within the operational design details. This ensures secure, reliable event notifications for resources like order.created actions.

How does idempotency-key behavior work for POST create endpoints in API contracts?

Idempotency-key behavior for POST create endpoints works by applying Stripe-style patterns to ensure safe create and update flows without duplicate processing. Defining this behavior in your API contract prevents accidental duplicate requests from creating multiple identical resources.

Can I use this API design approach for both REST and GraphQL services?

Yes, you can use this API design approach for both REST and GraphQL services by producing an OpenAPI 3.1 specification alongside operational design details for real HTTP services. It accommodates defining resources, endpoints, response contracts, and production security checklists for both architectures.

What should be included in a production-ready API security checklist for HTTP services?

A production-ready API security checklist for HTTP services should include input validation, safe failure responses, structured error envelopes, and webhook HMAC-SHA256 signature verification. Enforcing correct method usage and consistent status-code mappings ensures secure, reliable operational behavior.