AGENT SKILL

rest

REST API design principles and best practices

适用职业设计师
License 许可
MIT
最近更新
2026-03-01
Stars
★ 3
Forks
2

01 前言 Front Matter

name
rest
license
MIT
metadata
{ "audience": "developers", "category": "api-design" }
description
REST API design principles and best practices
compatibility
opencode

03 SKILL.md 正文

What I do

  • Design RESTful APIs
  • Use proper HTTP methods
  • Implement proper status codes
  • Handle pagination and filtering
  • Version APIs
  • Secure endpoints

When to use me

When building or consuming REST APIs.

HTTP Methods

GET    /users        - List users
GET    /users/:id    - Get user
POST   /users        - Create user
PUT    /users/:id    - Update user (full)
PATCH  /users/:id    - Partial update
DELETE /users/:id    - Delete user

Status Codes

200 OK
201 Created
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Response Format

{
  "data": { "id": 1, "name": "John" },
  "meta": { "total": 100, "page": 1 },
  "links": { "self": "/users/1" }
}

04 同仓库更多 Skills