skills.rest
lichong-a
lichong-aCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

ric-api-design

Design REST, OpenAPI, RPC, and service contract APIs with schemas, authentication, and error handling.

Updated Jun 4, 2026
Search Tags:#authentication#REST#permissions#API design#OpenAPI#RPC#service contracts
One-click install
npx skills add https://github.com/lichong-a/ric-skills --skill ric-api-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ric-api-design
Source: https://github.com/lichong-a/ric-skills/tree/main/skills/ric-api-design
Command: npx skills add https://github.com/lichong-a/ric-skills --skill ric-api-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the API design process for REST, OpenAPI, and other styles, reducing complexity and improving collaboration.

Core Features & Use Cases

  • API Design Guidance: Provides structured guidance for defining contracts, HTTP methods, paths, and more.
  • REST Conventions: Implements best practices for RESTful APIs, including consistent patterns and error shaping.
  • Auth & Permissions: Ensures secure design with proper authentication, permissions, and error handling.
  • Documentation Integration: Integrates with OpenAPI/docs to maintain accurate API documentation.
  • Use Case: Ideal for a team developing APIs where consistent design, security, and documentation are crucial.

Quick Start

Utilize the ric-api-design skill to outline the API design for a new REST API, ensuring it adheres to industry standards.

Frequently Asked Questions about ric-api-design

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

FAQPage Schema
How do I design REST APIs with consistent schemas and error handling?▼

Design REST APIs by defining structured service contracts, standardizing HTTP methods and paths, and shaping consistent error codes. This ensures frontend-backend integration and maintains compatibility across your project.

What's the best way to document OpenAPI specifications for a new API?▼

Document OpenAPI specifications by integrating design guidance directly with docs to maintain accurate API references. This streamlines the process of defining schemas, authentication, and service contracts.

How do I implement authentication and permissions in an RPC service contract?▼

Implement authentication and permissions in an RPC service contract by applying structured security guidance during API design. This ensures proper access control and secure error handling across endpoints.

Can I use this API design approach for frontend-backend integration in ric projects?▼

Yes, this API design approach specifically targets ric projects to ensure seamless frontend-backend integration. It validates schemas, authentication, and compatibility across REST, OpenAPI, and RPC styles.

When do I need to define service contracts versus standard REST conventions?▼

Define service contracts when you need strict schema validation and frontend-backend compatibility across RPC and REST. Standard REST conventions suffice for simpler HTTP-based APIs without complex cross-service requirements.

Related Skills

Explore More Software Engineering Skills→
nicholasgriffintnnicholasgriffintn
2

backend-design

Plan backend systems, APIs, and data models with structured architecture decisions.

Community
Basic
rrezartprebrezarrezartprebreza
203

openapi-first

Generate Spring-compatible controllers, DTOs, and client stubs from OpenAPI specs.

Community
Intermediate
vertivolatamvertivolatam
1

API Gateway & Rate Limiting

Implement API Gateways with Kong and Nginx rate limiting strategies.

Official
Advanced
chidekinachidekina
2

api-design-principles

Define and enforce scalable REST and GraphQL API design patterns.

Community
Advanced