add-api-endpoint

Scaffold REST API endpoints with controllers, OpenAPI specs, routes, and tests.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/johngrandson/orkestry --skill add-api-endpoint-johngrandson
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: add-api-endpoint
Source: https://github.com/johngrandson/orkestry/tree/main/.claude/skills/add-api-endpoint
Command: npx skills add https://github.com/johngrandson/orkestry --skill add-api-endpoint-johngrandson

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the scaffolding of a new REST API endpoint within the Petal Pro API layer, including controller scaffolding, JSON view, OpenAPI specs, routing, and tests, ensuring consistent project structure.

Core Features & Use Cases

  • Endpoint scaffolding: Generates the controller, JSON view, OpenAPI specs, routes, and tests for a new API resource.
  • Routing & tests: Creates the correct routes, bearer-auth scaffolding, and test stubs to validate behavior.
  • Use Case: When adding a new resource to Petal Pro, run this skill to automatically produce all required API components and tests.

Quick Start

Provide the resource and actions (for example, 'items CRUD') and the skill will scaffold the controller, views, OpenAPI specs, and tests.

Frequently Asked Questions about add-api-endpoint

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

FAQPage Schema
How do I scaffold a new API endpoint in Phoenix with CRUD operations and tests?

Scaffolding a new API endpoint in Phoenix is automated by generating the controller, JSON view, OpenAPI specs, routing, and test stubs together. You provide the resource name and actions, and the skill outputs all required API components with bearer-auth protection.

What is the best way to add OpenAPI specs and bearer-auth protection to a new Elixir API resource?

The best way to add OpenAPI specs and bearer-auth protection is through automated scaffolding that wires routes and generates standard CRUD components. This ensures the new API resource has consistent project structure and valid OpenAPI documentation from the start.

Can I automatically generate controller, JSON view, and test scaffolds for a Petal Pro API layer?

Yes, you can automatically generate controller, JSON view, and test scaffolds for a Petal Pro API layer. The skill produces the correct routes, OpenAPI specs, and test stubs to validate behavior when you specify the resource and desired CRUD actions.

Does this API scaffolding tool work with standard REST resources and Elixir Phoenix?

This API scaffolding tool works with standard REST resources in Elixir Phoenix by applying automated generation to the Petal Pro API layer. It satisfies requirements for controllers, schemas, route wiring, and testing scaffolds for any new resource.

What components are included when scaffolding REST API endpoints for CRUD operations?

Components included when scaffolding REST API endpoints for CRUD operations are the controller, JSON view, OpenAPI specs, schemas, route wiring, and testing stubs. Bearer-auth scaffolding is also applied to secure the new resource endpoints.