sparc-architecture-example-1-api-architecture-openapi
Sub-skill of sparc-architecture: Example 1: API Architecture (OpenAPI) (+1).
Best use case
sparc-architecture-example-1-api-architecture-openapi is best used when you need a repeatable AI agent workflow instead of a one-off prompt.
Sub-skill of sparc-architecture: Example 1: API Architecture (OpenAPI) (+1).
Teams using sparc-architecture-example-1-api-architecture-openapi should expect a more consistent output, faster repeated execution, less prompt rewriting.
When to use this skill
- You want a reusable workflow that can be run more than once with consistent structure.
When not to use this skill
- You only need a quick one-off answer and do not need a reusable workflow.
- You cannot install or maintain the underlying files, dependencies, or repository context.
Installation
Claude Code / Cursor / Codex
Manual Installation
- Download SKILL.md from GitHub
- Place it in
.claude/skills/example-1-api-architecture-openapi/SKILL.mdinside your project - Restart your AI agent — it will auto-discover the skill
How sparc-architecture-example-1-api-architecture-openapi Compares
| Feature / Agent | sparc-architecture-example-1-api-architecture-openapi | Standard Approach |
|---|---|---|
| Platform Support | Not specified | Limited / Varies |
| Context Awareness | High | Baseline |
| Installation Complexity | Unknown | N/A |
Frequently Asked Questions
What does this skill do?
Sub-skill of sparc-architecture: Example 1: API Architecture (OpenAPI) (+1).
Where can I find the source code?
You can find the source code on GitHub using the link provided at the top of the page.
SKILL.md Source
# Example 1: API Architecture (OpenAPI) (+1)
## Example 1: API Architecture (OpenAPI)
```yaml
openapi: 3.0.0
info:
title: Authentication API
version: 1.0.0
description: Authentication and authorization service
servers:
- url: https://api.example.com/v1
description: Production
- url: https://staging-api.example.com/v1
description: Staging
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
apiKey:
type: apiKey
in: header
name: X-API-Key
schemas:
User:
type: object
properties:
id:
type: string
format: uuid
email:
type: string
format: email
roles:
type: array
items:
$ref: '#/components/schemas/Role'
Error:
type: object
required: [code, message]
properties:
code:
type: string
message:
type: string
details:
type: object
paths:
/auth/login:
post:
summary: User login
operationId: login
tags: [Authentication]
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [email, password]
properties:
email:
type: string
password:
type: string
responses:
200:
description: Successful login
content:
application/json:
schema:
type: object
properties:
token:
type: string
refreshToken:
type: string
user:
$ref: '#/components/schemas/User'
```
## Example 2: Infrastructure Architecture (Kubernetes)
```yaml
# Kubernetes Deployment Architecture
apiVersion: apps/v1
kind: Deployment
metadata:
name: auth-service
labels:
app: auth-service
spec:
replicas: 3
selector:
matchLabels:
app: auth-service
template:
metadata:
labels:
app: auth-service
spec:
containers:
- name: auth-service
image: auth-service:latest
ports:
- containerPort: 3000
env:
- name: NODE_ENV
value: "production"
- name: DATABASE_URL
valueFrom:
secretKeyRef:
name: db-secret
key: url
resources:
requests:
memory: "256Mi"
cpu: "250m"
limits:
memory: "512Mi"
cpu: "500m"
livenessProbe:
httpGet:
path: /health
port: 3000
initialDelaySeconds: 30
periodSeconds: 10
readinessProbe:
httpGet:
path: /ready
port: 3000
initialDelaySeconds: 5
periodSeconds: 5
---
apiVersion: v1
kind: Service
metadata:
name: auth-service
spec:
selector:
app: auth-service
ports:
- protocol: TCP
port: 80
targetPort: 3000
type: ClusterIP
```Related Skills
improve-codebase-architecture
Find deepening opportunities in a codebase, informed by the domain language in CONTEXT.md and the decisions in docs/adr/. Use when the user wants to improve architecture, find refactoring opportunities, consolidate tightly-coupled modules, or make a codebase more testable and AI-navigable.
label-driven-prompt-generation-architecture
Pattern for building automation scripts that classify GitHub issues into prompt templates using label-based routing and extract contextual data for batch processing
repo-architecture-analysis
Scan a Python repo's package structure, count classes/functions, classify module maturity (PRODUCTION/DEVELOPMENT/SKELETON/GAP), and generate architecture reports with Mermaid diagrams. Use when asked to analyze codebase structure, find untested packages, or assess module maturity.
doc-extraction-naval-architecture
Layer 3 domain sub-skill for extracting naval architecture data from SNAME PNA, IMO stability codes, IACS structural rules, and classification society guidelines. Provides detection heuristics for stability constants, resistance equations, hull form coefficients, hydrostatic curves, IMO stability criteria, and structural scantling tables. type: reference
sparc-specification
SPARC Specification phase specialist for requirements analysis, constraint identification, use case definition, and acceptance criteria creation
sparc-refinement
SPARC Refinement phase specialist for iterative improvement through TDD, code optimization, refactoring, performance tuning, and quality improvement
sparc-pseudocode
SPARC Pseudocode phase specialist for algorithm design, data structure selection, complexity analysis, and design pattern identification
sparc-architecture
SPARC Architecture phase specialist for system design, component architecture, interface design, scalability planning, and technology selection
architecture-diagram
Dark-themed SVG architecture/cloud/infra diagrams as HTML.
multi-tool-architecture-assessment
Systematic comparison of competing tools/approaches before committing to a multi-account, multi-tool architecture. Uses parallel subagents for research, system-state audit, and data quality analysis. Produces a decision matrix with explicit trade-offs.
modular-architecture-documentation
Systematically document multi-module system architectures including module boundaries, CLI commands, and architecture decisions.
discipline-refactor-orchestration-architecture
Sub-skill of discipline-refactor: Orchestration Architecture.