SuperAPI AI Directory

eliteforge-new-java-biz-package

Coding & development

View repository

Updated 10-15 20:12

About this skill

Java Business Package Skeleton

Generate directly according to the fixed skeleton, without switching controller directory styles. Prefer to use scripts/scaffold_java_biz_package.py to generate the directory skeleton, then add classes, documents, or placeholder files as requested by the user.

Workflow

  1. Confirm the target business package root directory, for example .../base/config、.../task or other domain packages under src/main/java .
  2. Run the script to create the skeleton; controller is fixed to generate api、innerapi、openapi。
  3. Only when the user explicitly requests it, then add Controller、ApplicationService、Repository、Mapper, DTO/VO/Entity and other Java files.
  4. Only when the user explicitly requests a design document, then use the $eliteforge-tech-doc and $eliteforge-java-uml skills to create docs/tech-design.md、.puml、.svg; if repository standards require it, call the corresponding document skill, and do not write empty placeholder documents.

Quick Commands

python3 scripts/scaffold_java_biz_package.py <target-dir>
python3 scripts/scaffold_java_biz_package.py <target-dir> --dry-run

Constraints

  • For the default skeleton, directory responsibilities, and naming placement, see references/layout-spec.md。
  • The controller subdirectory is fixed to use the all-lowercase package name api/innerapi/openapi, with no automatic detection and no switching parameter provided.
  • By default, create the root directory .gitkeep、repository/.gitkeep、service/.gitkeep. Do not indiscriminately add .gitkeepin all empty directories unless the user explicitly requests keeping empty directories.
  • service The root directory holds xxxApplicationService, and the implementation goes in service/impl。
  • repository The root directory holds xxxRepository, and the implementation goes in repository/impl, and MyBatis Mapper goes in repository/mapper。
  • controller/api faces the frontend,controller/innerapi faces internal service calls,controller/openapi faces the external open platform.
  • If the current repository requires that module design documents must use a specified skill, first call the corresponding skill according to repository standards, then add the real design artifacts under docs/ .
  • If the user only wants the directory skeleton, do not additionally generate fake classes, fake interfaces, fake UML, or empty-content design drafts.
  • If the user also requests "complete a full module," first use this skill to lay out the directories, then continue to add code and documents according to repository standards.