API Designer

SkillMedia

Once added, your AI can design RESTful APIs that follow best practices for consistency and usability. It helps produce API designs that hold together well across a project and are straightforward for developers to use. The skill comes from the skrills collection by athola.

Available today. Use it from your connected AI after setup.

After adding the skill, describe the API you need, including what it should do and who will use it, then ask your AI to design it. You can refine the result with follow-up requests in the same conversation.

Then ask your AI: use the API Designer skill

What your AI can do with it

  • Design RESTful APIs for new features or services
  • Structure resources and endpoints consistently
  • Apply best practices that make APIs easier to use
  • Keep naming and patterns uniform across an API

What this skill tells your AI

The instructions your AI receives, as published by athola/skrills in assets/demo-skills/api-designer/SKILL.md and read by ahel’s review.

Expert guidance for designing clean, consistent REST APIs.

REST Principles

  • Use nouns for resources, verbs for actions
  • Follow HTTP method semantics (GET, POST, PUT, DELETE)
  • Return appropriate status codes
  • Support content negotiation

URL Design

  • Use plural nouns for collections (/users, /posts)
  • Nest resources logically (/users/123/posts)
  • Use query parameters for filtering and pagination
  • Keep URLs readable and predictable

Response Format

  • Use consistent JSON structure
  • Include metadata for collections (total, page, etc.)
  • Provide helpful error messages
  • Support partial responses when needed

Versioning

  • Include version in URL or header
  • Maintain backward compatibility
  • Document breaking changes clearly
  • Deprecate gracefully with notice periods

Security

  • Use HTTPS everywhere
  • Implement proper authentication
  • Validate all inputs
  • Rate limit API endpoints
  • Log security-relevant events

Documentation

  • Provide OpenAPI/Swagger specs
  • Include request/response examples
  • Document error codes and meanings
  • Keep docs updated with changes

Signals

GitHub stars
69
Forks
10
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
api-designer
Source
github.com/athola/skrills