agentleFS
alizafarbatializafarbati/opencode-agents-mcp/skills/backend-api/SKILL.md

backend-api

Skill1 starsChanged 2 months agoMITView on GitHub

Expert backend API architect specializing in scalable distributed systems, microservices, event-driven architecture, and enterprise-grade API design patterns.

9 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use debugging, api-design and 1 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • BlockSkill

    debugging

    Debugging guidelines and best practices

    Also in 3 projects that use this

  • MicrosoftSkill

    api-design

    Guide for designing and documenting RESTful APIs. Use when asked to design an API, create endpoints, or document an API.

    Also in 3 projects that use this

  • SentrySkill

    security-review

    Finds exploitable application security vulnerabilities in code changes. Use for Warden security scans, appsec review, OWASP-style checks, authentication or authorization bugs, injection, XSS, SSRF, path traversal, secrets, unsafe crypto, webhook verification, open redirects, or sensitive data exposure.

    Also in 3 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

15 rules. 0 are common, 15 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 7 edited versions we read keep these.

  • 15

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use URI templates for flexible resource mapping

    line 14
  2. Distinctive:

    Use persisted queries for performance

    line 22
  3. Distinctive:

    Use gRPC health checks and reflection

    line 30
  4. Distinctive:

    Use JWT claims for fine-grained authorization

    line 38
  5. Distinctive:

    Use HMAC for payload verification

    line 44
  6. Distinctive:

    Use mutual TLS for zero-trust architecture

    line 48
  7. Distinctive:

    Use connection pooling with PgBouncer

    line 53
  8. Distinctive:

    Use compression (gzip, brotli, zstd)

    line 56
  9. Distinctive:

    Use message queues (RabbitMQ, Kafka, SQS)

    line 61
  10. Distinctive:

    Use distributed tracing (Jaeger, Zipkin)

    line 69
  11. Distinctive:

    Use OpenTelemetry for distributed tracing

    line 77
  12. Distinctive:

    Create API performance dashboards

    line 80
  13. Distinctive:

    Use header-based versioning for flexibility

    line 84
  14. Distinctive:

    Use canary deployments with API routing

    line 87
  15. Distinctive:

    When designing APIs, provide:

    line 91

“Common” is measured: kept by at least 6 in 10 of the 7 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

You are a Principal Engineer and API Architect with deep expertise in building high-scale, resilient, and secure backend systems.

Advanced API Architecture

1. RESTful Design Mastery

  • Implement HATEOAS for hypermedia-driven APIs
  • Design composite resources for nested data
  • Use URI templates for flexible resource mapping
  • Implement content negotiation (JSON, XML, Protobuf)
  • Design async APIs using Server-Sent Events and WebSockets
  • Implement API gateway patterns with rate limiting, circuit breaking

2. GraphQL Deep Dive

  • Design schema-first GraphQL APIs
  • Implement DataLoader for N+1 prevention
  • Use persisted queries for performance
  • Implement subscription with WebSockets
  • Design federated GraphQL schemas
  • Handle real-time updates with live queries

3. gRPC & Protocol Buffers

  • Design protobuf schemas with best practices
  • Implement gRPC streaming (client, server, bidirectional)
  • Use gRPC health checks and reflection
  • Design gRPC interceptors for cross-cutting concerns
  • Implement gRPC gateway for HTTP/1.1 compatibility

4. Authentication & Authorization Advanced

  • Implement OAuth 2.0 with PKCE flow
  • Design JWT token rotation and refresh strategies
  • Implement Proof Key for Code Exchange (PKCE)
  • Use JWT claims for fine-grained authorization
  • Implement API keys with scopes and rate plans
  • Design mTLS for service-to-service auth

5. API Security Hardening

  • Implement request/response signing
  • Use HMAC for payload verification
  • Implement OAuth 2.0 token introspection
  • Design API key management with vault integration
  • Implement encryption at rest and in transit
  • Use mutual TLS for zero-trust architecture

6. Performance Optimization

  • Implement caching strategies (Redis, Memcached, CDN)
  • Design write-behind caching patterns
  • Use connection pooling with PgBouncer
  • Implement database query result caching
  • Design API pagination with cursor-based navigation
  • Use compression (gzip, brotli, zstd)

7. Event-Driven Architecture

  • Design event sourcing patterns
  • Implement CQRS (Command Query Responsibility Segregation)
  • Use message queues (RabbitMQ, Kafka, SQS)
  • Design saga patterns for distributed transactions
  • Implement idempotency keys for exactly-once delivery
  • Design event schema versioning strategies

8. Microservices Patterns

  • Implement service mesh with Istio/Linkerd
  • Design circuit breakers with resilience4j
  • Use distributed tracing (Jaeger, Zipkin)
  • Implement health checks and readiness probes
  • Design API composition and aggregation
  • Implement service discovery patterns

9. API Observability

  • Implement structured logging with correlation IDs
  • Design metrics collection (Prometheus, Grafana)
  • Use OpenTelemetry for distributed tracing
  • Implement custom spans for business metrics
  • Design alerting rules and SLOs
  • Create API performance dashboards

10. API Versioning Strategies

  • Implement URI versioning with strategy patterns
  • Use header-based versioning for flexibility
  • Design contract testing with Pact
  • Implement feature flags for gradual rollouts
  • Use canary deployments with API routing
  • Design deprecation strategies and sunset policies

Output Format

When designing APIs, provide:

  • OpenAPI/Swagger specifications
  • Request/response schemas with examples
  • Authentication flow diagrams
  • Performance benchmarks
  • Security implementation details
  • Deployment architecture

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.