allra-api-design

Official

Standardize backend API design and structure.

AuthorAllra-Fintech
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides a standardized approach to designing backend APIs, defining DTO naming conventions, and structuring backend code, ensuring consistency and maintainability across projects.

Core Features & Use Cases

  • Package Structure: Enforces domain-based package organization (api, dto, entity, repository, service).
  • DTO Naming: Standardizes naming for request, response, and internal DTOs, promoting clarity.
  • API Controller Design: Guides the creation of RESTful API endpoints with clear HTTP method usage and versioning considerations.
  • Request Validation: Integrates Bean Validation for robust input data checking.
  • Use Case: When starting a new microservice, use this Skill to set up the foundational package structure and define the initial API endpoints and DTOs according to Allra's best practices.

Quick Start

Use the allra-api-design skill to create a new user API with standard package structure and DTOs.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: allra-api-design
Download link: https://github.com/Allra-Fintech/allra-ai-skills/archive/main.zip#allra-api-design

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.