Agent skill

Create API Endpoint

by rundeck in rundeck/rundeck

Create REST API endpoints with proper OpenAPI annotations, API versioning, and testing following Rundeck standards.

Apache-2.0Auto-check passedBackend & APIs

Install Create API Endpoint

skills CLI
$ npx skills add rundeck/rundeck --skill create-api-endpoint -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install rundeck/rundeck create-api-endpoint --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/rundeck/rundeck.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/create-api-endpoint .claude/skills/create-api-endpoint && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
create-api-endpoint
GitHub stars
6.3k
Token cost
~2k tokens
SKILL.md length
406 words
Files
1
Skills in repo
10
Repo updated
First seen
Licence
Apache-2.0

At a glance

Create REST API endpoints with proper OpenAPI annotations, API versioning, and testing following Rundeck standards.

  • Works in 8 steps: Load Context → Design API → Write API Tests First → …
  • Tasks that involve REST APIs
  • SKILL.md covers When to Use, Process, Required Annotations Summary and Checklist, plus 2 more sections
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md

What it does

Create API Endpoint is an agent skill from rundeck/rundeck. Create REST API endpoints with proper OpenAPI annotations, API versioning, and testing following Rundeck standards.

Its SKILL.md is about 2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Backend & APIs, covering REST APIs and OpenAPI specifications. It works with OpenAPI. The repository describes itself as: Enable Self-Service Operations: Give specific users access to your existing tools, services, and scripts. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve REST APIs
  • Tasks that involve OpenAPI specifications

Example prompts

  • “/create-api-endpoint”

Workflow steps

8 steps, taken from the step headings in SKILL.md.

  1. Load Context
  2. Design API
  3. Write API Tests First
  4. Create/Update DTOs
  5. Create/Update Controller
  6. Update build.gradle (If New Plugin)
  7. Run Tests and Verify
  8. Update Documentation

What it can do on your machine

Read from SKILL.md and the folder at commit 664a7dd. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are groovy and bash).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • docs.rundeck.com
    • github.com
    • micronaut-projects.github.io

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Create API Endpoint loads about 2k tokens when it runs. Until then it costs about 34 tokens; SKILL.md has 406 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~34
When it runs · the whole SKILL.md, loaded when a task matches
~2k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from rundeck/rundeck at commit 664a7dd, republished under its Apache-2.0 licence (© rundeck). 406 words, ~1,971 tokens.

Download SKILL.mdSave it as .claude/skills/create-api-endpoint/SKILL.md (or your agent's skills folder).
name
create-api-endpoint
description
Create REST API endpoints with proper OpenAPI annotations, API versioning, and testing following Rundeck standards.

Create API Endpoint Skill

When to Use

  • Creating new REST API endpoints
  • Modifying existing API endpoints
  • Need OpenAPI spec annotations
  • API versioning requirements

Process

Phase 1: Load Context

Automatically read:

  • .claude/docs/api-guidelines.md - Complete annotation guide
  • .claude/docs/development-guidelines.md - API versioning, documentation
  • .claude/docs/testing-guidelines.md - API testing requirements
Phase 2: Design API

Define:

  • HTTP method (GET/POST/PUT/DELETE)
  • URL path (must start with /api/$VERSION/...)
  • Request/Response DTOs
  • API version required (increment Current Version if new behavior)
  • Authentication requirements

API Versioning Rules:

  • New functionality → New API version
  • New endpoint → New API version
  • Modified endpoint → New API version
  • Bug fix → Same API version
Phase 3: Write API Tests First

Test Requirements:

  1. ✅ New behavior works with NEW API version
  2. ❌ New behavior does NOT work with OLD API version
  3. ✅ Error conditions return correct responses
  4. ✅ Success conditions work in all call patterns

Example Test:

groovy
def "should return projects for API v44"() {
    when:
    def response = client.get("/api/44/projects")
    
    then:
    response.status == 200
    response.json.size() > 0
}

def "should reject for API v43"() {
    when:
    def response = client.get("/api/43/projects")
    
    then:
    response.status == 404 // or appropriate error
}
Phase 4: Create/Update DTOs

Annotate Data Classes:

groovy
@Schema(description = "Project response")
class ProjectResponse {
    
    @Schema(description = "Project name", example = "MyProject")
    String name
    
    @Schema(description = "Project description")
    String description
    
    @Schema(description = "Creation date", example = "2025-01-01T00:00:00Z")
    String created
}
Phase 5: Create/Update Controller

Step 1: Add @Controller Annotation:

groovy
@Controller(value = "/api/44")
class ProjectController {
    // ...
}

Step 2: Annotate Method:

groovy
@Operation(
    method = "GET",
    summary = "List Projects",
    description = "Returns a list of all projects accessible to the user"
)
@Tag(name = "Project")
@ApiResponse(
    responseCode = "200",
    description = "Project list successfully retrieved",
    content = @Content(
        mediaType = "application/json",
        schema = @Schema(implementation = ProjectListResponse.class)
    )
)
@Get(uri = "/projects", produces = MediaType.APPLICATION_JSON)
def listProjects() {
    // implementation
}

For POST/PUT with Request Body:

groovy
@Operation(
    method = "POST",
    summary = "Create Project",
    description = "Creates a new project with the specified configuration",
    requestBody = @RequestBody(
        description = "Project configuration",
        content = @Content(
            mediaType = "application/json",
            schema = @Schema(implementation = ProjectCreateRequest.class)
        ),
        required = true
    )
)
@ApiResponse(
    responseCode = "201",
    description = "Project created successfully",
    content = @Content(
        mediaType = "application/json",
        schema = @Schema(implementation = ProjectResponse.class)
    )
)
@Post(uri = "/projects")
def createProject() {
    // implementation
}

For Query/Path Parameters:

groovy
@Parameters([
    @Parameter(
        name = "project",
        in = ParameterIn.PATH,
        description = "Project name",
        required = true,
        schema = @Schema(type = "string")
    ),
    @Parameter(
        name = "includeArchived",
        in = ParameterIn.QUERY,
        description = "Include archived items",
        schema = @Schema(type = "boolean", defaultValue = "false")
    )
])
@Get(uri = "/project/{project}/jobs")
def getProjectJobs() {
    // implementation
}
Phase 6: Update build.gradle (If New Plugin)
groovy
// Add dependencies using versions centralized in gradle.properties
compileOnly "io.micronaut.openapi:micronaut-openapi:${micronautOpenapiVersion}"
implementation "io.swagger.core.v3:swagger-annotations:${swaggerVersion}"

// Set target file
tasks.withType(GroovyCompile) {
    def target = new File(
        project.rootDir, 
        "rundeckapp/build/openapi/${project.name}.yml"
    ).absolutePath
    configure(groovyOptions) {
        forkOptions.jvmArgs = [
            '-Xmx1024m',
            "-Dmicronaut.openapi.target.file=${target}".toString()
        ]
    }
}
Phase 7: Run Tests and Verify
bash
# API tests
./gradlew :functional-test:apiTest

# Verify OpenAPI spec generated
ls rundeckapp/build/classes/groovy/main/META-INF/swagger/rundeck-*.yml

# Full test suite
./gradlew test
Phase 8: Update Documentation
  1. Rundeck Docs: Update API Reference
  2. API Version History: Document changes in API Version History
  3. If new API version: Document what was added/changed

Required Annotations Summary

Controller Level
groovy
@Controller(value = "/api/44/base-path")  // Required
Method Level
groovy
@Get|@Post|@Put|@Delete(uri = "/path")    // Required - HTTP method
@Operation(...)                             // Required - OpenAPI operation
@Tag(name = "Category")                     // Required - Grouping (or tags=["Category"] in @Operation)
@ApiResponse(...)                           // Required - Response definition
@Parameters([...])                          // Optional - Query/path params
Data Types
groovy
@Schema(...)                                // Required on DTO classes

Show full SKILL.md (193 more words)Show less

Checklist

Design:

  • API design reviewed (HTTP method, path, versioning)
  • API version incremented for new functionality

build.gradle:

  • Micronaut/Swagger dependencies added
  • Target file configured for plugin (if new plugin)

Controller:

  • Annotated with @Controller
  • Each method has @Get/@Post/@Put/@Delete
  • Each method has @Operation with detailed description
  • Each method has exactly one tag (@Tag(name = "X") or tags = ["X"] in @Operation)
  • Each method has @ApiResponse
  • Request body specified for POST/PUT
  • Parameters specified if needed

Data Types:

  • DTO classes annotated with @Schema
  • DTO fields annotated with @Schema

Testing:

  • API tests written first (TDD)
  • Tests verify new API version works
  • Tests verify old API version does NOT support new behavior
  • API tests pass

Verification:

  • Build and verify YAML generated in rundeckapp/build/classes/groovy/main/META-INF/swagger/
  • OpenAPI spec includes new endpoints
  • Rundeck documentation updated

Common Mistakes to Avoid

❌ Don't:

  • Forget @Controller annotation (methods won't appear in spec!)
  • Use old API version for new functionality
  • Skip API version tests
  • Omit @Schema on DTOs
  • Forget to update Rundeck docs

✅ Do:

  • Always use @Controller
  • Increment API version for new behavior
  • Test both old and new API versions
  • Annotate all DTOs completely
  • Update official documentation

Resources

© rundeck, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/create-api-endpoint of rundeck/rundeck.

Open the folder on GitHubat commit 664a7dd

Compare with similar skills

Create API Endpoint next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Create API Endpoint compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Create API Endpoint this skillrundeck/rundeck6.3k—~2kAutomated safety check: PassApache-2.0
API DesignerJeffallan/claude-skills12k2 repos~2kAutomated safety check: PassMIT
OpenAPI to MCP Servermcp-use/mcp-use11k—~5.2kAutomated safety check: PassApache-2.0
Use Yaakmountain-loop/yaak19k—~1.9kAutomated safety check: PassMIT
Old Coder API DesignAmazingAng/old-coder7491 repos~3.4kAutomated safety check: PassMIT
API CallerNVIDIA/SkillEvaluator5441 repos~1.1kAutomated safety check: PassApache-2.0

Similar skills

  • API Designer

    Jeffallan/claude-skills

    Designs REST and GraphQL APIs from resource modeling to an OpenAPI 3.1 contract, with versioning, pagination and RFC 7807 error handling.

    12k GitHub starsUsed in 2 repos~2k tokens
    Backend & APIsAuto-check passed
  • OpenAPI to MCP Server

    mcp-use/mcp-use

    Turns an OpenAPI or Swagger spec into an MCP server with the mcp-use TypeScript SDK, mapping each operation to a tool, wiring auth, testing and deploying.

    11k GitHub stars~5.2k tokensUpdated yesterday
    Backend & APIsAuto-check passed
  • Use Yaak

    mountain-loop/yaak

    A skill your agent uses when the user mentions Yaak, a Yaak workspace, or the yaak command, or asks to call, hit, or smoke test HTTP/REST endpoints, save or organize API requests for reuse or manual…

    19k GitHub stars~1.9k tokensUpdated today
    Backend & APIsAuto-check passed
  • Old Coder API Design

    AmazingAng/old-coder

    Reviews or designs an HTTP/JSON API's endpoints, auth, pagination, versioning and deprecations, guarding against inventing a bespoke interface or silently breaking consumers.

    749 GitHub starsUsed in 1 repo~3.4k tokens
    Backend & APIsAuto-check passed
  • API Caller

    NVIDIA/SkillEvaluator

    Official

    Call any REST API dynamically. An agent skill from NVIDIA/SkillEvaluator.

    544 GitHub starsUsed in 1 repo~1.1k tokens
    Backend & APIsAuto-check passed
  • API Generating

    huangjia2019/claude-code-engineering

    Generate API endpoint code and documentation from specifications.

    1.1k GitHub starsUsed in 1 repo~379 tokens
    Backend & APIsAuto-check passed

More from rundeck/rundeck

All 10 skills in this repo
  • Backport PR

    rundeck/rundeck

    Backport commits from an existing GitHub Pull Request to a target branch and open a new backport PR.

    6.3k GitHub stars~3k tokensUpdated today
    Auto-check passed
  • Cve Remediation

    rundeck/rundeck

    Verify if a CVE affects the project and remediate it. An agent skill from rundeck/rundeck.

    6.3k GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Generate standardized CONTEXT.md files for features. An agent skill from rundeck/rundeck.

    6.3k GitHub stars~2k tokensUpdated today
    Auto-check passed
  • I18n Vue Template

    rundeck/rundeck

    Internationalize Vue component templates by replacing all hardcoded strings with $t() calls and adding translations to i18n.ts or enUS.js.

    6.3k GitHub stars~523 tokensUpdated today
    Auto-check: notes
  • Onboard Contributor

    rundeck/rundeck

    Guide a new contributor through the rundeck OSS repo. An agent skill from rundeck/rundeck.

    6.3k GitHub stars~848 tokensUpdated today
    Auto-check passed
  • Write Jest Tests

    rundeck/rundeck

    Write Vue component unit tests. An agent skill from rundeck/rundeck.

    6.3k GitHub stars~486 tokensUpdated today
    Auto-check: notes

Works with

Categories

Questions about Create API Endpoint

What does Create API Endpoint do?

Create REST API endpoints with proper OpenAPI annotations, API versioning, and testing following Rundeck standards. Create API Endpoint is an agent skill from rundeck/rundeck. Create REST API endpoints with proper OpenAPI annotations, API versioning, and testing following Rundeck standards.

When should I use Create API Endpoint?

Create API Endpoint fits situations like: tasks that involve REST APIs; tasks that involve OpenAPI specifications.

How do I install Create API Endpoint in Claude Code?

Run `npx skills add rundeck/rundeck --skill create-api-endpoint -a claude-code`. Or copy the skill folder (.claude/skills/create-api-endpoint in rundeck/rundeck) into .claude/skills/create-api-endpoint in your project. Claude Code loads it when a task matches its description.

How do I install Create API Endpoint in Codex?

Run `npx skills add rundeck/rundeck --skill create-api-endpoint -a codex`. Or copy the skill folder (.claude/skills/create-api-endpoint in rundeck/rundeck) into .agents/skills/create-api-endpoint in your project. Codex loads it when a task matches its description.

Can I use Create API Endpoint in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add rundeck/rundeck --skill create-api-endpoint -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/create-api-endpoint, .gemini/skills/create-api-endpoint, .github/skills/create-api-endpoint and .opencode/skills/create-api-endpoint in your project.

What does Create API Endpoint need to run?

SKILL.md names no scripts, command-line tools or credentials: Create API Endpoint is instructions for the agent only.

Does Create API Endpoint access the network?

SKILL.md names 3 domains. As links in the text: docs.rundeck.com, github.com and micronaut-projects.github.io. This is read from the text; nothing was executed.

Is Create API Endpoint safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Create API Endpoint use?

Create API Endpoint is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Create API Endpoint use?

About 2k tokens (SKILL.md is roughly 7.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Create API Endpoint?

Skills that share tags, products or a category with Create API Endpoint: API Designer (Jeffallan/claude-skills, 12k stars), OpenAPI to MCP Server (mcp-use/mcp-use, 11k stars), Use Yaak (mountain-loop/yaak, 19k stars) and Old Coder API Design (AmazingAng/old-coder, 749 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Create API Endpoint?

rundeck (a GitHub organization) maintains it in rundeck/rundeck, which has 6,327 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on October 7, 2026.

Source: rundeck/rundeck on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.