skills.rest
nashirabbash
nashirabbashCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design RESTful and GraphQL APIs with endpoints, data models, and documentation.

Updated Mar 30, 2026
Search Tags:#design#documentation#openapi#rest#graphql#apis
One-click install
npx skills add https://github.com/nashirabbash/autorepychatbot --skill api-design-nashirabbash
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/nashirabbash/autorepychatbot/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/nashirabbash/autorepychatbot --skill api-design-nashirabbash

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design RESTful and GraphQL APIs following best practices to ensure consistency, maintainability, and scalable documentation across projects.

Core Features & Use Cases

  • Structured API design guidelines for REST and GraphQL, including resource naming, HTTP methods, status codes, pagination, and error handling.
  • OpenAPI & GraphQL documentation support to standardize specifications and enable tooling, mockups, and client generation.
  • Versioning and governance strategies to manage changes, deprecations, and compatibility across services.

Quick Start

Provide a concrete API design plan for a given domain, including resources, endpoints, and sample requests.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is the best way to design RESTful and GraphQL APIs for consistency and maintainability?▼

The best way to design robust APIs is to follow structured guidelines for resource naming, HTTP methods, pagination, and error handling, ensuring consistency and scalable documentation across new and modernized projects.

How do I generate OpenAPI and GraphQL documentation for my endpoints?▼

You can generate OpenAPI and GraphQL documentation by standardizing your API specifications, which enables tooling, mockups, and client generation while maintaining comprehensive endpoint and data model records.

How do I handle API versioning and deprecations across multiple services?▼

Handle API versioning and deprecations by applying governance strategies that manage changes and maintain compatibility across services, ensuring smooth transitions when updating RESTful or GraphQL endpoints.

Does this API design approach support both new projects and API modernization?▼

Yes, this API design approach applies to both new API projects and API modernization efforts, specifying endpoints, data models, authentication, pagination, and testing criteria for robust implementation.

Can I standardize error handling and pagination in my GraphQL and REST APIs?▼

Yes, you can standardize error handling and pagination by applying structured API design guidelines that define consistent HTTP status codes and data retrieval patterns for both REST and GraphQL architectures.

Related Skills

Explore More Software Engineering Skills→
BradliebsBradliebs

ce-plan

Transform feature descriptions into structured implementation plans with repo-relative file paths.

Community
Advanced
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
qazuorqazuor

api-app-testing

Plan and implement REST API tests with schema validation and coverage reports.

Community
Advanced
vuralserhat86vuralserhat86
43

api_design

Design RESTful and GraphQL APIs with OpenAPI and GraphQL schemas.

Community
Intermediate