Create HTTP API contracts with REST and GraphQL paradigms.
npx skills add https://github.com/voidrot/agents --skill api-design-voidrot
Please help me install this Agent Skill. Skill: api-design Source: https://github.com/voidrot/agents/tree/main/skills/meta/api-design Command: npx skills add https://github.com/voidrot/agents --skill api-design-voidrot
This Skill simplifies the process of designing and reviewing HTTP API contracts, streamlining the creation of resourceful, efficient, and maintainable APIs.
Use the api-design skill to create a new API endpoint for the 'users' resource.
High-intent search queries and answers about installing and using this skill.
To design HTTP API contracts, define resource models, HTTP semantics, and validation rules. The skill facilitates creating APIs by handling REST and GraphQL paradigms, authorization, rate limiting, and versioning while adhering to OpenAPI standards.
The best way to structure REST API resources is by following predefined patterns for methods, status codes, and pagination. You can use workflow guidelines for audience identification and method selection to ensure proper HTTP semantics and OpenAPI behavior.
Yes, this API design approach supports OpenAPI and Swagger standards. It requires awareness of these standards to facilitate the creation of resourceful contracts and utilizes scripts for automated design validation and documentation generation.
You can automate API contract validation and documentation generation using Python scripts. The skill utilizes Python scripts to validate HTTP semantics, resource modeling, and authorization rules defined within your API contracts.
To handle error handling and API versioning boundaries, clearly define the scope boundaries between client-side API contracts and server internals. The skill provides guidelines for validation, error handling, and documentation to maintain efficient APIs.
librefangExtract text, tables, and form data from PDF documents into Markdown, JSON, or CSV.
CuriousLearnerGenerate OpenAPI 3.0 specifications and documentation from existing codebases.
kanade0404Design REST API structures with endpoint planning, pagination, filtering, and error handling.
chidekinaDefine and enforce scalable REST and GraphQL API design patterns.
