skills.rest
AIDotNet
AIDotNetOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-designer

Design RESTful API endpoints and generate OpenAPI 3.0 specifications.

84|15|Updated Dec 31, 2025
Search Tags:#design#documentation#api#openapi#rest#swagger
One-click install
npx skills add https://github.com/AIDotNet/MoYuCode --skill api-designer-aidotnet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/AIDotNet/MoYuCode/tree/main/skills/community/api-designer
Command: npx skills add https://github.com/AIDotNet/MoYuCode --skill api-designer-aidotnet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines the process of designing robust RESTful APIs and generating industry-standard OpenAPI/Swagger documentation, ensuring consistency and best practices.

Core Features & Use Cases

  • API Endpoint Design: Creates well-structured RESTful endpoints following naming conventions.
  • Schema Definition: Defines clear request and response JSON schemas.
  • OpenAPI Generation: Produces OpenAPI 3.0+ specifications for easy integration and documentation.
  • Use Case: A developer needs to define a new set of endpoints for a user management system and requires a formal OpenAPI specification to share with the frontend team.

Quick Start

Use the api-designer skill to design a RESTful API for managing blog posts, including endpoints for creating, reading, updating, and deleting posts, and generate an OpenAPI 3.0 specification.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate an OpenAPI 3.0 specification for a new REST API?▼

To generate an OpenAPI specification, define your RESTful API resource requirements and the system produces a formal OpenAPI/Swagger document with structured endpoints, schemas, and standard HTTP methods.

What is the best way to design RESTful API endpoints with proper naming conventions?▼

Designing RESTful API endpoints involves applying resource-oriented design principles to ensure consistent naming, proper HTTP methods, correct status codes, and standardized versioning for robust API architecture.

How do I define request and response JSON schemas for my Swagger documentation?▼

Defining request and response JSON schemas for Swagger documentation requires specifying your data structure, which generates clear schema definitions integrated directly into your OpenAPI specification.

Can I use this to design a REST API for a user management system with pagination?▼

Yes, you can design a REST API for a user management system that includes pagination. It structures resource-oriented endpoints and incorporates pagination parameters into the generated OpenAPI specification.

Does the generated OpenAPI specification include best practices for HTTP status codes?▼

Yes, the generated OpenAPI specification includes best practices for HTTP status codes. It ensures adherence to industry standards by applying correct status codes and proper HTTP methods during endpoint design.

Related Skills

Explore More Software Engineering Skills→
changgengluchanggenglu

api-designer

Define RESTful API designs and OpenAPI 3.0 specifications from user prompts.

Community
Advanced
rrezartprebrezarrezartprebreza
203

openapi-first

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

Community
Intermediate
heidsoftheidsoft
57

api-integration-testing

Automate API integration testing for requests, responses, and authentication.

Community
Advanced
sandeshbagmaresandeshbagmare

api-design-principles

Explain REST and GraphQL API design principles, including resource-oriented architecture and schema-first development.

Community
Advanced