skills.rest
changgenglu
changgengluCOMMUNITY
Explore all skills by this author →
GitHub

api-designer

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

Updated Jul 13, 2023
Search Tags:#documentation#security#openapi#rest#api-design#interface-spec
One-click install
npx skills add https://github.com/changgenglu/changgenglu-blog --skill api-designer-changgenglu
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/changgenglu/changgenglu-blog/tree/main/prompt_engineering/gemini/skills/api-designer
Command: npx skills add https://github.com/changgenglu/changgenglu-blog --skill api-designer-changgenglu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Designing APIs can be error-prone and time-consuming without consistent guidelines. This skill provides structured RESTful design principles, endpoint patterns, and OpenAPI documentation practices to accelerate development and ensure interoperability.

Core Features & Use Cases

  • RESTful design principles, including method semantics, URL conventions, and versioning.
  • OpenAPI-driven interface specifications and example schemas for common resources.
  • API security best practices and error handling guidance across services.
  • Use Case: A team designing a new user service can generate a complete API plan and OpenAPI spec from requirements.

Quick Start

Provide a project prompt (resources, endpoints, and security needs) and I will generate a RESTful API design and an OpenAPI spec.

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 spec from a RESTful API design prompt?▼

Provide a project prompt with resources, endpoints, and security needs to generate a RESTful API design and a complete OpenAPI 3.0 specification. The skill enforces structured requirements for request/response formats, error handling, and security practices.

What is the best way to design RESTful API endpoints and method semantics?▼

The best way to design RESTful API endpoints is by applying structured design principles for method semantics, URL conventions, and versioning. This ensures consistent interface specifications and interoperability across software projects.

Can I use this to define API security best practices and error handling?▼

Yes, you can define API security best practices and error handling guidance across services. It enforces structured requirements for security practices using OpenAPI 3.0 conventions to prevent common API design errors.

Does this approach enforce OpenAPI 3.0 conventions for interface specs?▼

Yes, it enforces OpenAPI 3.0 conventions for interface specifications and example schemas. This ensures your API design follows structured requirements for request/response formats and documentation practices.

What are the limitations of generating API documentation from requirements prompts?▼

Generating API documentation from requirements prompts requires providing complete project inputs including resources, endpoints, and security needs. It outputs RESTful API design guidelines and OpenAPI specs, but does not implement the backend code.

Do I need prior OpenAPI knowledge to define RESTful API specs with this method?▼

You do not need extensive OpenAPI knowledge to define RESTful API specs. Provide a project prompt describing your resources and security needs, and it will generate the OpenAPI documentation and RESTful design guidelines automatically.

Related Skills

Explore More Software Engineering Skills→
LowyShinLowyShin
33

phase-4-api

Design REST APIs using templates and validate behavior via Zero Script QA with PDCA workflow and structured logs.

Community
Advanced
HouseGarofaloHouseGarofalo
3

openapi-swagger

Design, document, and generate APIs from OpenAPI and Swagger specifications.

Official
Advanced
traylinxtraylinx
2

api-designer

Design REST APIs and OpenAPI specifications with endpoint naming and schema validation.

Official
Advanced
lamb92009lamb92009

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced