skills.rest
PriyanshKuniyal
PriyanshKuniyalCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Provide guidelines for designing REST and GraphQL APIs.

Updated Jul 8, 2026
Search Tags:#schema design#api design#rest#graphql#restful design
One-click install
npx skills add https://github.com/PriyanshKuniyal/gemini-cli-resources --skill api-design-principles-priyanshkuniyal
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/PriyanshKuniyal/gemini-cli-resources/tree/main/extensions/claude-code-workflows/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/PriyanshKuniyal/gemini-cli-resources --skill api-design-principles-priyanshkuniyal

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers master REST and GraphQL API design principles, ensuring intuitive, scalable, and maintainable APIs that meet the highest standards.

Core Features & Use Cases

  • RESTful Design Principles: Learn the fundamentals of RESTful design, including resource-oriented architecture, HTTP methods, and status codes.
  • GraphQL Design Principles: Understand schema-first development, query structure, and API versioning strategies for GraphQL.
  • Best Practices: Gain insights into best practices for REST and GraphQL APIs, including naming conventions, pagination, error handling, and security.
  • Use Case: Use this Skill to design a new REST or GraphQL API, review an existing API specification, or establish API design standards for your team.

Quick Start

Use the api-design-principles skill to review the design principles for REST APIs.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the core principles for RESTful API design?▼

GraphQL schema design follows a schema-first development approach, focusing on query structure and API versioning strategies. This Skill details how to implement resolvers and structure types for maintainable APIs.

How do I handle pagination and error handling in REST and GraphQL APIs?▼

API design best practices for pagination and error handling are covered comprehensively, alongside naming conventions and security. This Skill offers detailed patterns and worked examples for both REST and GraphQL implementations.

Do I need prior HTTP and JSON knowledge to use these API design patterns?▼

Yes, designing APIs with these guidelines requires existing knowledge of HTTP, JSON, and schema design. This Skill builds on that foundation to teach advanced resolver implementation and resource-oriented architecture.

When should I choose GraphQL schema design over RESTful API design?▼

Choosing between REST and GraphQL depends on your query structure needs and versioning strategies. This Skill compares both approaches, providing detailed patterns and best practices to help you decide.

Related Skills

Explore More Software Engineering Skills→
darelabs-techdarelabs-tech

dare-init

Scaffold DARE methodology project structures and configuration files.

Official
Intermediate
fulfonfulfon

api-designer

Design RESTful and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
ianyimiianyimi
1

Global Tech Stack

Enforce coding standards for the global tech stack in Claude Code.

Community
Basic
ThorstensenThorstensen

serialization

Select optimal serialization formats for .NET applications.

Community
Advanced