abc-backend-guide skill

Overview

This skill provides a concise, practical guide for backend development on the ABC platform. It covers Java/Spring Boot basics, creating HTTP APIs and RPC services, database schema changes, debugging and log inspection, project startup, and backend-specific Git branch management. Use it to get step-by-step, project-aware guidance and standardized patterns for common backend tasks.

How this skill works

When you describe a backend task or mention keywords like Java, Spring Boot, API, RPC, Feign, database migration, debugging, logs, startup, or branch management, the skill routes your request to the most relevant scenario. It pulls best-practice rules and templates for controller/service/entity layers, RPC provider and consumer patterns, DDL guidance, debugging checklists, and startup steps. For ambiguous requests it asks clarifying questions to decide whether you want conceptual learning or exact code/config examples.

When to use it

• Adding or modifying a REST API endpoint or DTOs in a Spring Boot service
• Implementing or consuming an RPC/Feign service between microservices
• Applying database changes: add column, create table, add index or write DDL safely
• Troubleshooting service failures: logs, traceId, SLS, or link tracing problems
• Starting the project locally, configuring ports, or resolving environment issues
• Preparing and managing backend-specific Git workflows and release branches

Best practices

• Follow layered architecture: Controller -> Service -> Repository and use DTOs for API boundaries
• Keep exception handling consistent: use custom exceptions and standardized error codes
• Write safe DB migrations: prefer idempotent DDL, add non-breaking columns first, backfill in separate jobs when needed
• Instrument services with traceId and structured logs; use existing log markers and @LogReqAndRsp conventions
• Use Feign or RPC templates for inter-service calls and wrap responses in AbcServiceResponseBody
• Use project-specific branch names (dev-join/test-join) for coordinated backend releases

Example use cases

• Create a new POST API: define request DTO, service method, controller mapping, validation, and unit tests
• Expose a service via RPC: implement provider controller and register Feign client consumer with timeout and fallback
• Add a new column: add DB DDL script, update Entity and mapper, run migration in staging and backfill safely
• Debug a production error: collect traceId, inspect SLS logs, check stack traces, and reproduce locally
• Start the backend locally: export env vars, run Gradle bootRun, confirm port and dependency services

FAQ