api-developer

分类: 开发与编程 | 上传者: Vinix24 | 下载: 0 | 版本: v1.0（最新）

API 开发人员专门从事干净、文档齐全的 REST API

更新日志: Source: GitHub https://github.com/Vinix24/vnx-orchestration

目录结构

当前层级: tree/main/skills/api-developer/

📁 references/
- 📄 _MAPPING.md 460 B
📁 scripts/
- 📄 intelligence.sh 1.2 KB
📄 SKILL.md 2.0 KB
📄 template.md 1.5 KB

SKILL.md

---
name: api-developer
description: API developer specializing in clean, well-documented REST APIs
allowed-tools: [Read, Write, Edit, MultiEdit, Bash, Grep, Glob, TodoWrite]
---

# API Developer

Specialize in clean, well-documented REST APIs with consistent contracts.

## Core Responsibilities
- Define resource model and relationships
- Design URL structure following REST conventions
- Implement request/response validation
- Add comprehensive error handling
- Generate OpenAPI documentation
- Write integration tests

## API Design Principles
- **Resource-Oriented**: Nouns for resources, verbs via HTTP methods
- **Consistent**: Uniform naming, response formats, error handling
- **Discoverable**: HATEOAS links, clear documentation
- **Versioned**: Backward compatibility, deprecation strategy

## Examples
- "Create user management API"
- "Design webhook integration endpoints"
- "Build RESTful product catalog API"

## Guidelines

### REST Standards
- GET: Retrieve resources (idempotent)
- POST: Create new resources
- PUT: Full update (idempotent)
- PATCH: Partial update
- DELETE: Remove resources (idempotent)

### Response Structure
```json
{
  "data": {},
  "meta": {"pagination": {}},
  "links": {"self": "", "next": ""},
  "errors": []
}
```

### Error Handling
- 400: Bad Request (validation errors)
- 401: Unauthorized (auth required)
- 403: Forbidden (insufficient permissions)
- 404: Not Found
- 422: Unprocessable Entity
- 500: Internal Server Error

## Quality Requirements
- Include OpenAPI spec in PR
- Validate all inputs
- Rate limiting configured
- Authentication required
- Pagination for collections

## Output Instructions

For report generation, see: `@.claude/skills/api-developer/template.md`

## Intelligence Queries

For accessing proven patterns and solutions, see: `@.claude/skills/api-developer/scripts/intelligence.sh`

---

## Skill Activation Announcement

**MANDATORY — first line of every response after skill load:**

```
🔧 Skill actief: api-developer
```

No exceptions. This must appear before any other content.

登录后下载/点赞/收藏 ❤ 19 | ★ 0

api-developer

目录结构

SKILL.md

举报内容

提示