API Design Safety

•
772
•

Enforces best practices for REST API response structures to prevent field misalignment, type ambiguity, and inconsistent error handling.

This skill provides a comprehensive safety framework for designing and modifying REST API responses. It helps developers avoid common pitfalls such as Java method overloading ambiguities—where string data is often misclassified as a status message—and ensures consistent handling of null values and empty arrays. By implementing these standardized patterns, the skill ensures that frontend-backend communication remains robust and predictable, separating transport-level HTTP status codes from application-level business logic across various languages including Java, Go, and Node.js.

主な機能

01Enforces consistent handling for null objects, empty lists, and pagination
02Provides multi-language support for Spring Boot, Gin, Express, and FastAPI
03Decouples HTTP transport status codes from business logic codes
04Prevents Java generic method overloading ambiguity for String response types
05Standardizes core response fields including code, message, data, and timestamp
06772 GitHub stars

ユースケース

01Refactoring legacy API endpoints to ensure consistent and predictable data structures
02Troubleshooting frontend integration bugs caused by ambiguous API return types
03Designing a new RESTful microservice response architecture from scratch