Skills allra-api-design
πŸ“¦

allra-api-design

Content revision r2 Safe βš™οΈ External commands

Design Consistent Spring Boot APIs

Inconsistent API structure and DTO naming make Java services harder to maintain. This skill applies Allra conventions for Spring Boot endpoints, validation, responses, and packages.

Supports: Claude Codex Code(CC)
πŸ₯‰ 78 Bronze

Install with my Agent

Copy this request to your Agent. It includes the canonical Skill page and manifest.

Agent request
Review the Skillstore skill "allra-api-design" from https://skillstore.io/skills/allra-fintech-allra-api-design.md and its manifest at https://skillstore.io/api/skills/allra-fintech-allra-api-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Your Agent should still show its plan and request any confirmation required by the security policy.

Agent-readable resources

Use these links when an AI agent, crawler, or script needs clean context instead of reading the full page.

Markdown detail GET /skills/allra-fintech-allra-api-design.md Signed manifest GET /api/skills/allra-fintech-allra-api-design/manifest Signed lockfile GET /api/skills/allra-fintech-allra-api-design/lockfile

Test it

Using "allra-api-design". Design DTO names for creating and returning a product.

Expected outcome:

  • Request: CreateProductRequest
  • Response: ProductResponse
  • Internal summary projection: ProductSummaryDto

Using "allra-api-design". Outline packages for a user domain.

Expected outcome:

  • api contains UserController.
  • dto/request and dto/response contain client-facing records.
  • entity, repository, and service separate persistence and business responsibilities.

Using "allra-api-design". Review a POST endpoint with an unvalidated request object.

Expected outcome:

Add Valid to the request body parameter and Bean Validation annotations to required request record fields.

Security Audit

Safe
v9 β€’ 7/23/2026 Open versioned report

All 31 static findings are false positives caused by Markdown backticks, fenced examples, and ordinary Java request parameters. The skill is a documentation-only API design guide with no command execution, system reconnaissance, or prompt injection behavior.

1
Files scanned
269
Lines analyzed
0
Review items
0
False positives ignored

Risk Factors

βš™οΈ External commands (26)
SKILL.md:24-32 SKILL.md:32-34 SKILL.md:34 SKILL.md:38-55 SKILL.md:55-61 SKILL.md:61-62 SKILL.md:62 SKILL.md:63-64 SKILL.md:64 SKILL.md:68-71 SKILL.md:71 SKILL.md:77-96 SKILL.md:96-102 SKILL.md:102-137 SKILL.md:137-139 SKILL.md:139-145 SKILL.md:145-158 SKILL.md:158-165 SKILL.md:165-170 SKILL.md:170-173 SKILL.md:173-181 SKILL.md:181-199 SKILL.md:199-236 SKILL.md:236-240 SKILL.md:240-257 SKILL.md:257-268
No confirmed security findings were detected by the latest completed static and semantic audit. This does not prove the skill has no side effects.
Audited by: codex View Audit History β†’
Share & cite this report

Share the versioned assessment report, neutral badge, embed card, and citations. Skillstore reports evidence without deciding whether this Skill is safe.

Open versioned report
Security Assessment

Copy report link

https://skillstore.io/skills/allra-fintech-allra-api-design/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/allra-fintech-allra-api-design/security.svg)](https://skillstore.io/skills/allra-fintech-allra-api-design?utm_source=security_passport_badge)

HTML badge

<a href="https://skillstore.io/skills/allra-fintech-allra-api-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/allra-fintech-allra-api-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Embed card

<iframe src="https://skillstore.io/embed/skills/allra-fintech-allra-api-design.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>
Academic citations (APA Β· BibTeX Β· CFF)

APA citation

Allra-Fintech. (2026). allra-api-design security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/allra-fintech-allra-api-design/audits/9

BibTeX citation

@techreport{allra-fintech-allra-fintech-allra-api-design-2026, author = {Allra-Fintech}, title = {allra-api-design security audit report (audit version 9)}, institution = {Skillstore}, year = {2026}, number = {9}, url = {https://skillstore.io/skills/allra-fintech-allra-api-design/audits/9}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "allra-api-design security audit report (audit version 9)" version: "unspecified" type: report authors: - name: "Allra-Fintech" date-released: "2026-07-23" url: "https://skillstore.io/skills/allra-fintech-allra-api-design/audits/9" identifiers: - type: other value: "skillstore:allra-fintech-allra-api-design:audit:9" description: "Skillstore immutable audit report identifier"

Skillstore Score

Why this score Evidence Confidence: High
55
Architecture
85
Maintainability
87
Content
70
Community
83
Spec Compliance

What You Can Build

Create a New Domain API

Define packages, DTOs, validation, and controller endpoints for a new Spring Boot domain.

Standardize Existing Endpoints

Review endpoint names, HTTP methods, DTO suffixes, and response formats against Allra conventions.

Prepare API Design Guidance

Produce consistent examples and checklists for teams adopting Java REST API standards.

Try These Prompts

Name a DTO 
Name the request and response DTOs for a user password reset operation. Explain how each name follows the Allra convention.
Design an Endpoint 
Design a Spring Boot endpoint that creates an order. Include the route, HTTP method, request record, validation, and response record.
Structure a Domain 
Propose a domain-based package structure for a product catalog. Include controller, DTO, entity, repository, and service files with suitable names.
Review an API Module 
Review this Spring Boot API module against Allra conventions. Identify naming, package, validation, REST mapping, and response-format issues, then propose corrected designs: [module details]

Best Practices

  • Keep package responsibilities clear and organize files by business domain.
  • Use records for simple DTOs when project requirements permit.
  • Validate request DTOs and keep endpoint naming consistent across the service.

Avoid

  • Do not reuse persistence entities as client request or response models.
  • Do not mix request, response, and internal DTO naming conventions.
  • Do not apply API versioning or response envelopes without checking project policy.

Frequently Asked Questions

Which Java and Spring Boot versions does this skill target?
It targets Java 17 or newer and Spring Boot 3.2 or newer.
Does the skill generate complete production code?
No. It provides structures and examples that require business logic, security controls, testing, and project integration.
When should an internal class use the Dto suffix?
Use the Dto suffix for internal transfer, query projection, or event data that is not a client contract.
Are Java records required for every DTO?
No. Records are recommended for simple data carriers when framework and project constraints permit them.
Does every endpoint need an API version in its path?
No. Apply path versioning only when the project's API policy requires it.
Can the response envelope be changed?
Yes. The documented success and error envelopes are examples, so use the format established by the target project.

Developer Details

License

MIT

Skillstore revision

r2

Version notice

The author did not declare a version.

Repository

https://github.com/Allra-Fintech/allra-ai-skills/tree/main/backend-plugin/skills/api-design

Ref

31bc7611b504c197d3e993aef7943461c871616f

Maintenance freshness

7/26/2026

Usage

10 downloads Β· 233 views

File structure

πŸ“„ SKILL.md