Skills
.Work. You
Rest

internal-api-standards

Community

Standardize internal API design.

Software Engineering#design#documentation#api#backend#standards#dto
Authorpdylanross
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the inconsistency and potential for breaking changes in internal API endpoints by enforcing strict standards for Data Transfer Objects (DTOs), package organization, and documentation.

Core Features & Use Cases

  • DTO Enforcement: Ensures dedicated DTOs are used for API requests and responses, decoupling them from internal implementation types.
  • Structured DTO Organization: Provides a clear convention for organizing DTOs within pkg/api/ to mirror route structures.
  • Swagger Annotation Requirement: Mandates Swagger annotations for all internal API handlers to ensure discoverability and usability via tools like Swagger UI.
  • Use Case: When developing new internal API endpoints, this Skill guides developers to create clean, maintainable, and well-documented interfaces that are resilient to internal code refactoring.

Quick Start

Follow the DTO requirement to define dedicated DTOs for API request and response types.

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: internal-api-standards
Download link: https://github.com/pdylanross/barnacle/archive/main.zip#internal-api-standards

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 223,000+ vetted skills library on demand.