create-api-endpoint

Automate REST API endpoint creation with OpenAPI annotations and versioning.

6.3k|984|Updated Sep 3, 2010
One-click install
npx skills add https://github.com/rundeck/rundeck --skill create-api-endpoint-rundeck
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: create-api-endpoint
Source: https://github.com/rundeck/rundeck/tree/main/.claude/skills/create-api-endpoint
Command: npx skills add https://github.com/rundeck/rundeck --skill create-api-endpoint-rundeck

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires micronaut-openapi, swagger-annotations, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of REST API endpoints with proper OpenAPI annotations, API versioning, and testing, following Rundeck standards, saving time and reducing errors in API development.

Core Features & Use Cases

  • Automated API Endpoint Creation: Generates API endpoints with OpenAPI annotations and versioning.
  • API Versioning: Handles API versioning rules for new functionality and endpoints.
  • Testing: Ensures API endpoints are tested for functionality and error conditions.
  • Use Case: Ideal for developers who need to quickly create and test new API endpoints in a Rundeck environment.

Quick Start

Use the create-api-endpoint skill to generate a new API endpoint for listing projects with the version '44'.

Frequently Asked Questions about create-api-endpoint

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

FAQPage Schema
How do I automate REST API endpoint creation with OpenAPI annotations in a Rundeck environment?

Automating REST API endpoint creation in a Rundeck environment is handled by generating controllers, URL paths, and DTOs with proper OpenAPI annotations and API versioning. This ensures compliance with Rundeck standards while reducing manual coding errors.

Do I need Micronaut OpenAPI and Swagger annotations to generate API endpoints?

Yes, Micronaut OpenAPI and Swagger annotations are required dependencies to generate API endpoints. The automation relies on these frameworks to properly map HTTP methods, URL paths, and DTOs with correct OpenAPI documentation.

What is the best way to handle API versioning when adding new REST endpoints?

Handling API versioning for new REST endpoints is managed automatically by applying Rundeck API versioning rules during endpoint generation. This ensures new functionality and endpoints follow strict versioning standards without manual intervention.

How does automated API endpoint generation handle HTTP methods and DTOs?

Automated API endpoint generation handles HTTP methods and DTOs by parsing your endpoint requirements and generating controller annotations, URL paths, and data transfer objects. It structures these elements according to OpenAPI and Rundeck compliance standards.

Can I test REST API endpoints for functionality and error conditions during creation?

Yes, you can test REST API endpoints for functionality and error conditions during creation. The automation process includes generating tests alongside the OpenAPI annotated endpoints to validate behavior and error handling.

Why use an automated approach for creating OpenAPI standard endpoints instead of manual coding?

Using an automated approach for creating OpenAPI standard endpoints saves time and reduces errors compared to manual coding. It guarantees Rundeck compliance, handles API versioning rules, and automatically generates necessary tests.