skills.rest
gykk16
gykk16COMMUNITY
Explore all skills by this author →
GitHub

controller-design

Define RESTful controller conventions for URL structure, HTTP methods, and ApiResource responses.

Updated Jan 11, 2026
Search Tags:#rest api#response format#api conventions#api best practices#controller design#url design
One-click install
npx skills add https://github.com/gykk16/spring-skeleton --skill controller-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: controller-design
Source: https://github.com/gykk16/spring-skeleton/tree/main/.omc/skills/controller-design
Command: npx skills add https://github.com/gykk16/spring-skeleton --skill controller-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures consistency and adherence to best practices in RESTful API controller design, leading to more maintainable, understandable, and scalable backend services.

Core Features & Use Cases

  • URL Design Conventions: Enforces standardized URL patterns, including versioning, kebab-case, and plural resource names.
  • Response Formatting: Mandates the use of ApiResource for consistent API responses.
  • Search Endpoint Patterns: Provides guidelines for implementing efficient and maintainable search functionality.
  • Use Case: When developing a new microservice, use this Skill to guide the creation of its controllers, ensuring all endpoints follow the established company-wide API standards from the outset.

Quick Start

Apply the controller design rules to ensure all API paths start with /api/v1/, use kebab-case, and plural nouns for resource collections.

Frequently Asked Questions about controller-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
What are the best practices for REST API controller design and URL structure?▼

REST API controller design best practices mandate base paths starting with /api/v1/, kebab-case formatting, and plural nouns for resource collections to ensure scalable and maintainable backend services.

How do I format REST API responses using ApiResource conventions?▼

You format REST API responses by mandating the use of ApiResource, which enforces consistent API response structures across all endpoints and standardizes data output formatting.

How should I implement search endpoints in a RESTful controller?▼

Implement search endpoints in RESTful controllers by following established search endpoint patterns that provide efficient and maintainable search functionality while adhering to standardized URL conventions.

What are common pitfalls in REST API controller development?▼

Common pitfalls in REST API controller development include incorrect method and parameter annotation ordering, improper handling of date-time inputs and outputs, and failing to follow kebab-case URL conventions.

Do I need specific dependencies to standardize my RESTful controller conventions?▼

No specific dependencies are required to standardize RESTful controller conventions. The guidelines focus on applying architectural rules for HTTP method mapping, URL design, and ApiResource response formatting.

Related Skills

Explore More Software Engineering Skills→
ortus-boxlangortus-boxlang

bx-orm-entities

Define BoxLang ORM entities with persistent annotations and table mappings.

Official
Intermediate
cosmicstack-labscosmicstack-labs
364

api-documentation

Create API documentation from OpenAPI/Swagger specs with runnable examples.

Official
Advanced
chavangorakh1999chavangorakh1999
1

express-api

Generate an Express.js REST API project template with Joi validation and error handling.

Community
Advanced
vtexdocsvtexdocs
39

vtex-io-graphql-api

Expose data through a GraphQL API in VTEX IO apps with schemas, resolvers, and directives.

Official
Advanced