Skills
.Work. You
Rest

sf-api-design

Community

Design secure, consistent Salesforce APIs

Software Engineering#security#rest#error-handling#salesforce#apex#api-design#batch-operations
Authorjiten-singh-shahi
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Provides concrete patterns and guardrails for designing inbound Salesforce APIs so integrators and developers avoid security mistakes, governor limit surprises, and inconsistent error handling that break clients and create operational risk.

Core Features & Use Cases

  • API structure & patterns: guidance for REST and SOAP endpoints, versioning, pagination, and batch operations so APIs remain maintainable and scalable.
  • Security & permissions: recommendations for CRUD/FLS enforcement, WITH USER_MODE, Security.stripInaccessible(), and authentication patterns (Named Principal, Per-User, JWT).
  • Error handling & responses: standardized response envelopes, structured error codes, and proper HTTP status usage that allow clients to programmatically react to failures.
  • Review & compliance: use when authoring or auditing Apex REST classes, building bulk endpoints, or defining integration contracts for external consumers.

Quick Start

Ask the skill to review an Apex REST class and produce a prioritized checklist of security, pagination, error-handling, and authentication improvements.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: sf-api-design
Download link: https://github.com/jiten-singh-shahi/salesforce-claude-code/archive/main.zip#sf-api-design

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.