http-entity-creator

Generate HTTP CRUD endpoints for domain entities in ores.http.server.

25|5|Updated Jun 15, 2024
One-click install
npx skills add https://github.com/OreStudio/OreStudio --skill http-entity-creator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: http-entity-creator
Source: https://github.com/OreStudio/OreStudio/tree/main/.claude/skills/http-entity-creator
Command: npx skills add https://github.com/OreStudio/OreStudio --skill http-entity-creator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams rapidly bootstrap HTTP REST endpoints for new domain entities by following standardized patterns (list, save, delete, history) and wiring them into the OreHTTP server, reducing boilerplate and ensuring consistency.

Core Features & Use Cases

  • Standardized CRUD scaffolding: Generates list, save, delete, and history endpoints aligned with the project conventions.
  • OpenAPI integration: Ensures endpoints are described for automatic API documentation and client generation.
  • Phase-driven workflow: Supports the three-phase PR process including route registration and application integration.

Quick Start

Define the target domain entity and run the HTTP endpoint creator. This will scaffold the routes class, register it with the router, and prepare OpenAPI metadata for the entity.

Frequently Asked Questions about http-entity-creator

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

FAQPage Schema
How do I auto-generate REST endpoints for new domain entities?

To auto-generate REST endpoints for domain entities, define the target entity and run the HTTP endpoint creator to scaffold list, save, delete, and history routes. It automatically wires these CRUD operations into the OreHTTP server while applying standard routing patterns.

Does generating HTTP CRUD endpoints include OpenAPI documentation?

Yes, generating HTTP CRUD endpoints includes OpenAPI integration to ensure all routes are fully described. This automatically produces API documentation and enables client generation for the standardized list, save, delete, and history operations.

What is the best way to reduce boilerplate when creating REST routing patterns?

The best way to reduce boilerplate when creating REST routing patterns is using an automated scaffolding process. It applies standardized CRUD conventions across entities, automatically registering routes with the router to ensure consistency and eliminate repetitive manual setup.

Can I use standardized CRUD scaffolding across multiple development phases?

Yes, you can use standardized CRUD scaffolding across multiple development phases. The generation process supports a three-phase PR workflow that includes route registration and application integration, ensuring consistency throughout the entire entity lifecycle.

Do I need to manually register routes after scaffolding HTTP endpoints?

No, you do not need to manually register routes after scaffolding HTTP endpoints. The generation process automatically handles route registration with the router and prepares the necessary OpenAPI metadata for the domain entity.