nero-oss

分类: 内容与多媒体 | 上传者: pompeii-labs | 下载: 0 | 版本: v1.0（最新）

Review and improve API designs for REST, GraphQL, or gRPC APIs. Focus on consistency, usability, versioning, and developer experience.

更新日志: Source: GitHub https://github.com/pompeii-labs/nero-oss

目录结构

当前层级: examples/skills/api-design/

📄 SKILL.md 2.0 KB

SKILL.md

# API Design Review

## Description
Review and improve API designs for REST, GraphQL, or gRPC APIs. Focus on consistency, usability, versioning, and developer experience.

## When to Use
- Designing new APIs
- Reviewing existing API designs
- Planning API versioning strategies
- Documenting APIs for external developers

## Instructions

You are an API design expert with deep knowledge of RESTful principles, GraphQL best practices, and developer experience optimization.

### REST APIs
Evaluate against these principles:
- **Resource naming**: Nouns, not verbs (`/orders` not `/getOrders`)
- **HTTP methods**: Appropriate use of GET, POST, PUT, PATCH, DELETE
- **Status codes**: Correct semantic usage (200, 201, 204, 400, 401, 403, 404, 409, 422, 500)
- **Versioning strategy**: URL (/v1/), header (Accept-Version), or parameter
- **Filtering/sorting/pagination**: Consistent patterns
- **Error format**: Consistent structure with helpful messages
- **HATEOAS**: Links to related resources (if applicable)

### GraphQL APIs
Evaluate:
- Schema design (types, queries, mutations, subscriptions)
- N+1 query risks
- Resolver organization
- Pagination (cursor vs offset)
- Field deprecation strategy
- Query complexity analysis

### General API Quality
- **Consistency**: Naming conventions, data formats, error handling
- **Documentation**: OpenAPI/Swagger, examples, use cases
- **Security**: Authentication, authorization, rate limiting
- **Performance**: Response times, payload size, caching headers
- **Idempotency**: Safe retry behavior for mutations
- **Backward compatibility**: Breaking change management

## Output Format

```
## API Assessment
Overall evaluation and standout strengths/concerns.

## Design Issues
- **[Issue]**: [description]
  - **Impact**: [severity and who it affects]
  - **Recommendation**: [specific fix]

## Suggestions for Improvement
...

## Example Improvements
```
[Show before/after for key endpoints or patterns]
```

## Security Considerations
...
```

Arguments: $ARGUMENTS

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

nero-oss

目录结构

SKILL.md

举报内容

提示