Skills
.Work. You
Rest

api-guide

Official

Guides building robust REST and GraphQL APIs.

Software Engineering#api#graphql#rest-api#scope-prefix#processor-patterns#admin-checks#client-sdk
Authorlablup
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill provides a structured blueprint for implementing REST and GraphQL APIs with consistent patterns, covering standard operations (create, get, search, update, delete, purge), scope prefix rules, admin prefixes, and client SDK/CLI integration.

Core Features & Use Cases

  • Standard API patterns: Defines six operations (create, get, search, update, delete, purge) plus batch variants for bulk updates, deletes, and purges.
  • Scope and Admin patterns: Supports domain-scoped REST/GraphQL endpoints and admin-only operations with permission checks.
  • Client SDK & CLI integration: Aligns with client SDK generation and CLI commands for seamless end-to-end usage.
  • Guidance for architectures: Includes patterns for REST handler → Processor → Service → Repository, GraphQL resolvers, adapters, and domain scope types.

Quick Start

Implement a minimal domain API following the guide: define REST resources and GraphQL types, apply scope/prefix rules, add admin checks, and wire up SDK/CLI integration.

Dependency Matrix

Required Modules

service-guiderepository-guide

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: api-guide
Download link: https://github.com/lablup/backend.ai/archive/main.zip#api-guide

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 223,000+ vetted skills library on demand.