Skills
.Work. You
Rest

api-naming

Official

Standardize API paths, access, and versioning

Software Engineering#versioning#authentication#api#routing#openapi#naming#tenant
AuthorArtisanCloud
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill defines a clear, enforceable API naming and access convention for PowerX to eliminate inconsistent endpoints, unclear versioning, and accidental exposure of internal/plugin APIs, reducing security gaps and integration friction.

Core Features & Use Cases

  • Path prefix and boundary rules: Clarifies public (/api/v1), management (/api/v1/admin) and internal (<APIPrefix>/internal) domains and their intended audiences.
  • Versioning and compatibility: Prescribes where stable public APIs live and how to introduce breaking changes with new versions.
  • Authentication and tenant handling: Requires auth for admin and internal routes and specifies tenant propagation and validation to prevent cross-tenant access.
  • Plugin and reverse-proxy patterns: Documents host plugin proxy paths, plugin internal endpoints, and examples for plugin lifecycle and governance.
  • OpenAPI and audit guidance: Specifies which endpoints must expose OpenAPI and what tracing/audit metadata to include for observability and compliance.

Quick Start

Audit your service routes against the PowerX API naming and access rules and list any mismatches with recommended fixes.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-naming
Download link: https://github.com/ArtisanCloud/PowerX/archive/main.zip#api-naming

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.