codehava-agent-kit 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +56 -0
- package/bin/cli.js +56 -0
- package/package.json +26 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/charts.csv +26 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/colors.csv +97 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/icons.csv +101 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/landing.csv +31 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/products.csv +97 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/prompts.csv +24 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/react-performance.csv +45 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/styles.csv +59 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/typography.csv +58 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/templates/.agent/.shared/ui-ux-pro-max/data/web-interface.csv +31 -0
- package/templates/.agent/.shared/ui-ux-pro-max/scripts/__pycache__/core.cpython-313.pyc +0 -0
- package/templates/.agent/.shared/ui-ux-pro-max/scripts/__pycache__/design_system.cpython-313.pyc +0 -0
- package/templates/.agent/.shared/ui-ux-pro-max/scripts/core.py +258 -0
- package/templates/.agent/.shared/ui-ux-pro-max/scripts/design_system.py +1067 -0
- package/templates/.agent/.shared/ui-ux-pro-max/scripts/search.py +106 -0
- package/templates/.agent/agents/backend-specialist.md +263 -0
- package/templates/.agent/agents/code-archaeologist.md +106 -0
- package/templates/.agent/agents/database-architect.md +226 -0
- package/templates/.agent/agents/debugger.md +225 -0
- package/templates/.agent/agents/devops-engineer.md +242 -0
- package/templates/.agent/agents/documentation-writer.md +104 -0
- package/templates/.agent/agents/explorer-agent.md +73 -0
- package/templates/.agent/agents/frontend-specialist.md +593 -0
- package/templates/.agent/agents/game-developer.md +162 -0
- package/templates/.agent/agents/mobile-developer.md +377 -0
- package/templates/.agent/agents/orchestrator.md +416 -0
- package/templates/.agent/agents/penetration-tester.md +188 -0
- package/templates/.agent/agents/performance-optimizer.md +187 -0
- package/templates/.agent/agents/product-manager.md +112 -0
- package/templates/.agent/agents/product-owner.md +95 -0
- package/templates/.agent/agents/project-planner.md +406 -0
- package/templates/.agent/agents/qa-automation-engineer.md +103 -0
- package/templates/.agent/agents/security-auditor.md +170 -0
- package/templates/.agent/agents/seo-specialist.md +111 -0
- package/templates/.agent/agents/test-engineer.md +158 -0
- package/templates/.agent/mcp_config.json +129 -0
- package/templates/.agent/rules/GEMINI.md +273 -0
- package/templates/.agent/scripts/auto_preview.py +148 -0
- package/templates/.agent/scripts/checklist.py +217 -0
- package/templates/.agent/scripts/session_manager.py +120 -0
- package/templates/.agent/scripts/verify_all.py +327 -0
- package/templates/.agent/skills/api-patterns/SKILL.md +81 -0
- package/templates/.agent/skills/api-patterns/api-style.md +42 -0
- package/templates/.agent/skills/api-patterns/auth.md +24 -0
- package/templates/.agent/skills/api-patterns/documentation.md +26 -0
- package/templates/.agent/skills/api-patterns/graphql.md +41 -0
- package/templates/.agent/skills/api-patterns/rate-limiting.md +31 -0
- package/templates/.agent/skills/api-patterns/response.md +37 -0
- package/templates/.agent/skills/api-patterns/rest.md +40 -0
- package/templates/.agent/skills/api-patterns/scripts/api_validator.py +211 -0
- package/templates/.agent/skills/api-patterns/security-testing.md +122 -0
- package/templates/.agent/skills/api-patterns/trpc.md +41 -0
- package/templates/.agent/skills/api-patterns/versioning.md +22 -0
- package/templates/.agent/skills/app-builder/SKILL.md +75 -0
- package/templates/.agent/skills/app-builder/agent-coordination.md +71 -0
- package/templates/.agent/skills/app-builder/feature-building.md +53 -0
- package/templates/.agent/skills/app-builder/project-detection.md +34 -0
- package/templates/.agent/skills/app-builder/scaffolding.md +118 -0
- package/templates/.agent/skills/app-builder/tech-stack.md +41 -0
- package/templates/.agent/skills/app-builder/templates/SKILL.md +39 -0
- package/templates/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/templates/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/templates/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/templates/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/templates/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/templates/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/templates/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/templates/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -0
- package/templates/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -0
- package/templates/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -0
- package/templates/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -0
- package/templates/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/templates/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -0
- package/templates/.agent/skills/architecture/SKILL.md +55 -0
- package/templates/.agent/skills/architecture/context-discovery.md +43 -0
- package/templates/.agent/skills/architecture/examples.md +94 -0
- package/templates/.agent/skills/architecture/pattern-selection.md +68 -0
- package/templates/.agent/skills/architecture/patterns-reference.md +50 -0
- package/templates/.agent/skills/architecture/trade-off-analysis.md +77 -0
- package/templates/.agent/skills/bash-linux/SKILL.md +199 -0
- package/templates/.agent/skills/behavioral-modes/SKILL.md +242 -0
- package/templates/.agent/skills/better-auth-patterns/SKILL.md +121 -0
- package/templates/.agent/skills/brainstorming/SKILL.md +163 -0
- package/templates/.agent/skills/brainstorming/dynamic-questioning.md +350 -0
- package/templates/.agent/skills/bullmq-worker/SKILL.md +124 -0
- package/templates/.agent/skills/clean-code/SKILL.md +201 -0
- package/templates/.agent/skills/code-review-checklist/SKILL.md +109 -0
- package/templates/.agent/skills/database-design/SKILL.md +52 -0
- package/templates/.agent/skills/database-design/database-selection.md +43 -0
- package/templates/.agent/skills/database-design/indexing.md +39 -0
- package/templates/.agent/skills/database-design/migrations.md +48 -0
- package/templates/.agent/skills/database-design/optimization.md +36 -0
- package/templates/.agent/skills/database-design/orm-selection.md +30 -0
- package/templates/.agent/skills/database-design/schema-design.md +56 -0
- package/templates/.agent/skills/database-design/scripts/schema_validator.py +172 -0
- package/templates/.agent/skills/deployment-procedures/SKILL.md +241 -0
- package/templates/.agent/skills/doc.md +177 -0
- package/templates/.agent/skills/documentation-templates/SKILL.md +194 -0
- package/templates/.agent/skills/feature-spec-writer/SKILL.md +76 -0
- package/templates/.agent/skills/frontend-design/SKILL.md +452 -0
- package/templates/.agent/skills/frontend-design/animation-guide.md +331 -0
- package/templates/.agent/skills/frontend-design/color-system.md +311 -0
- package/templates/.agent/skills/frontend-design/decision-trees.md +418 -0
- package/templates/.agent/skills/frontend-design/motion-graphics.md +306 -0
- package/templates/.agent/skills/frontend-design/scripts/accessibility_checker.py +183 -0
- package/templates/.agent/skills/frontend-design/scripts/ux_audit.py +722 -0
- package/templates/.agent/skills/frontend-design/typography-system.md +345 -0
- package/templates/.agent/skills/frontend-design/ux-psychology.md +1116 -0
- package/templates/.agent/skills/frontend-design/visual-effects.md +383 -0
- package/templates/.agent/skills/game-development/2d-games/SKILL.md +119 -0
- package/templates/.agent/skills/game-development/3d-games/SKILL.md +135 -0
- package/templates/.agent/skills/game-development/SKILL.md +167 -0
- package/templates/.agent/skills/game-development/game-art/SKILL.md +185 -0
- package/templates/.agent/skills/game-development/game-audio/SKILL.md +190 -0
- package/templates/.agent/skills/game-development/game-design/SKILL.md +129 -0
- package/templates/.agent/skills/game-development/mobile-games/SKILL.md +108 -0
- package/templates/.agent/skills/game-development/multiplayer/SKILL.md +132 -0
- package/templates/.agent/skills/game-development/pc-games/SKILL.md +144 -0
- package/templates/.agent/skills/game-development/vr-ar/SKILL.md +123 -0
- package/templates/.agent/skills/game-development/web-games/SKILL.md +150 -0
- package/templates/.agent/skills/geo-fundamentals/SKILL.md +156 -0
- package/templates/.agent/skills/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/templates/.agent/skills/i18n-localization/SKILL.md +154 -0
- package/templates/.agent/skills/i18n-localization/scripts/i18n_checker.py +241 -0
- package/templates/.agent/skills/intelligent-routing/SKILL.md +335 -0
- package/templates/.agent/skills/lint-and-validate/SKILL.md +45 -0
- package/templates/.agent/skills/lint-and-validate/scripts/lint_runner.py +184 -0
- package/templates/.agent/skills/lint-and-validate/scripts/type_coverage.py +173 -0
- package/templates/.agent/skills/mcp-builder/SKILL.md +176 -0
- package/templates/.agent/skills/mobile-design/SKILL.md +394 -0
- package/templates/.agent/skills/mobile-design/decision-trees.md +516 -0
- package/templates/.agent/skills/mobile-design/mobile-backend.md +491 -0
- package/templates/.agent/skills/mobile-design/mobile-color-system.md +420 -0
- package/templates/.agent/skills/mobile-design/mobile-debugging.md +122 -0
- package/templates/.agent/skills/mobile-design/mobile-design-thinking.md +357 -0
- package/templates/.agent/skills/mobile-design/mobile-navigation.md +458 -0
- package/templates/.agent/skills/mobile-design/mobile-performance.md +767 -0
- package/templates/.agent/skills/mobile-design/mobile-testing.md +356 -0
- package/templates/.agent/skills/mobile-design/mobile-typography.md +433 -0
- package/templates/.agent/skills/mobile-design/platform-android.md +666 -0
- package/templates/.agent/skills/mobile-design/platform-ios.md +561 -0
- package/templates/.agent/skills/mobile-design/scripts/mobile_audit.py +670 -0
- package/templates/.agent/skills/mobile-design/touch-psychology.md +537 -0
- package/templates/.agent/skills/neo-storage/SKILL.md +115 -0
- package/templates/.agent/skills/nextjs-api-route/SKILL.md +134 -0
- package/templates/.agent/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +351 -0
- package/templates/.agent/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/templates/.agent/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/templates/.agent/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/templates/.agent/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/templates/.agent/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/templates/.agent/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/templates/.agent/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/templates/.agent/skills/nextjs-react-expert/9-cache-components.md +103 -0
- package/templates/.agent/skills/nextjs-react-expert/SKILL.md +293 -0
- package/templates/.agent/skills/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/templates/.agent/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/templates/.agent/skills/nodejs-best-practices/SKILL.md +333 -0
- package/templates/.agent/skills/parallel-agents/SKILL.md +175 -0
- package/templates/.agent/skills/performance-profiling/SKILL.md +143 -0
- package/templates/.agent/skills/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/templates/.agent/skills/plan-writing/SKILL.md +152 -0
- package/templates/.agent/skills/powershell-windows/SKILL.md +167 -0
- package/templates/.agent/skills/prisma-7-patterns/SKILL.md +91 -0
- package/templates/.agent/skills/python-patterns/SKILL.md +441 -0
- package/templates/.agent/skills/red-team-tactics/SKILL.md +199 -0
- package/templates/.agent/skills/rust-pro/SKILL.md +176 -0
- package/templates/.agent/skills/seo-fundamentals/SKILL.md +129 -0
- package/templates/.agent/skills/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/templates/.agent/skills/server-management/SKILL.md +161 -0
- package/templates/.agent/skills/systematic-debugging/SKILL.md +109 -0
- package/templates/.agent/skills/tailwind-patterns/SKILL.md +269 -0
- package/templates/.agent/skills/tdd-workflow/SKILL.md +149 -0
- package/templates/.agent/skills/testing-patterns/SKILL.md +178 -0
- package/templates/.agent/skills/testing-patterns/scripts/test_runner.py +219 -0
- package/templates/.agent/skills/uu-pdp-feature-check/SKILL.md +116 -0
- package/templates/.agent/skills/vibe-buildplan/SKILL.md +232 -0
- package/templates/.agent/skills/vibe-prd/SKILL.md +226 -0
- package/templates/.agent/skills/vibe-research/SKILL.md +162 -0
- package/templates/.agent/skills/vibe-techdesign/SKILL.md +195 -0
- package/templates/.agent/skills/vulnerability-scanner/SKILL.md +276 -0
- package/templates/.agent/skills/vulnerability-scanner/checklists.md +121 -0
- package/templates/.agent/skills/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/templates/.agent/skills/web-design-guidelines/SKILL.md +57 -0
- package/templates/.agent/skills/webapp-testing/SKILL.md +187 -0
- package/templates/.agent/skills/webapp-testing/scripts/playwright_runner.py +173 -0
- package/templates/.agent/skills/xendit-integration/SKILL.md +100 -0
- package/templates/.agent/snippets/@react-component-template.tsx +29 -0
- package/templates/.agent/workflows/brainstorm.md +113 -0
- package/templates/.agent/workflows/create.md +59 -0
- package/templates/.agent/workflows/db-migrate.md +26 -0
- package/templates/.agent/workflows/debug.md +103 -0
- package/templates/.agent/workflows/deploy.md +35 -0
- package/templates/.agent/workflows/dev-reset.md +40 -0
- package/templates/.agent/workflows/enhance.md +63 -0
- package/templates/.agent/workflows/git-commit.md +24 -0
- package/templates/.agent/workflows/health-check.md +34 -0
- package/templates/.agent/workflows/new-feature.md +32 -0
- package/templates/.agent/workflows/orchestrate.md +237 -0
- package/templates/.agent/workflows/plan.md +89 -0
- package/templates/.agent/workflows/preview.md +81 -0
- package/templates/.agent/workflows/status.md +86 -0
- package/templates/.agent/workflows/test.md +144 -0
- package/templates/.agent/workflows/ui-ux-pro-max.md +296 -0
- package/templates/.agent/workflows/vibe-plan.md +133 -0
- package/templates/.agent/workflows/vibe-recap.md +17 -0
- package/templates/.antigravity/rules.md +64 -0
- package/templates/AGENTS.md +268 -0
- package/templates/docs/00A-PROJECT-CHARTER.md +33 -0
- package/templates/docs/00B-BRD.md +25 -0
- package/templates/docs/01-PRD.md +122 -0
- package/templates/docs/01B-SRS-LENGKAP.md +60 -0
- package/templates/docs/02-TECH-DESIGN.md +491 -0
- package/templates/docs/03-UI-GUIDELINES.md +301 -0
- package/templates/docs/04-BACKLOG.md +127 -0
- package/templates/docs/05-DEPLOYMENT.md +363 -0
- package/templates/docs/06-DEVELOPMENT-LOG.md +78 -0
- package/templates/specs/README.md +54 -0
|
@@ -0,0 +1,327 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
Full Verification Suite - Antigravity Kit
|
|
4
|
+
==========================================
|
|
5
|
+
|
|
6
|
+
Runs COMPLETE validation including all checks + performance + E2E.
|
|
7
|
+
Use this before deployment or major releases.
|
|
8
|
+
|
|
9
|
+
Usage:
|
|
10
|
+
python scripts/verify_all.py . --url <URL>
|
|
11
|
+
|
|
12
|
+
Includes ALL checks:
|
|
13
|
+
✅ Security Scan (OWASP, secrets, dependencies)
|
|
14
|
+
✅ Lint & Type Coverage
|
|
15
|
+
✅ Schema Validation
|
|
16
|
+
✅ Test Suite (unit + integration)
|
|
17
|
+
✅ UX Audit (psychology, accessibility)
|
|
18
|
+
✅ SEO Check
|
|
19
|
+
✅ Lighthouse (Core Web Vitals)
|
|
20
|
+
✅ Playwright E2E
|
|
21
|
+
✅ Bundle Analysis (if applicable)
|
|
22
|
+
✅ Mobile Audit (if applicable)
|
|
23
|
+
"""
|
|
24
|
+
|
|
25
|
+
import sys
|
|
26
|
+
import subprocess
|
|
27
|
+
import argparse
|
|
28
|
+
from pathlib import Path
|
|
29
|
+
from typing import List, Dict, Optional
|
|
30
|
+
from datetime import datetime
|
|
31
|
+
|
|
32
|
+
# ANSI colors
|
|
33
|
+
class Colors:
|
|
34
|
+
HEADER = '\033[95m'
|
|
35
|
+
BLUE = '\033[94m'
|
|
36
|
+
CYAN = '\033[96m'
|
|
37
|
+
GREEN = '\033[92m'
|
|
38
|
+
YELLOW = '\033[93m'
|
|
39
|
+
RED = '\033[91m'
|
|
40
|
+
ENDC = '\033[0m'
|
|
41
|
+
BOLD = '\033[1m'
|
|
42
|
+
|
|
43
|
+
def print_header(text: str):
|
|
44
|
+
print(f"\n{Colors.BOLD}{Colors.CYAN}{'='*70}{Colors.ENDC}")
|
|
45
|
+
print(f"{Colors.BOLD}{Colors.CYAN}{text.center(70)}{Colors.ENDC}")
|
|
46
|
+
print(f"{Colors.BOLD}{Colors.CYAN}{'='*70}{Colors.ENDC}\n")
|
|
47
|
+
|
|
48
|
+
def print_step(text: str):
|
|
49
|
+
print(f"{Colors.BOLD}{Colors.BLUE}🔄 {text}{Colors.ENDC}")
|
|
50
|
+
|
|
51
|
+
def print_success(text: str):
|
|
52
|
+
print(f"{Colors.GREEN}✅ {text}{Colors.ENDC}")
|
|
53
|
+
|
|
54
|
+
def print_warning(text: str):
|
|
55
|
+
print(f"{Colors.YELLOW}⚠️ {text}{Colors.ENDC}")
|
|
56
|
+
|
|
57
|
+
def print_error(text: str):
|
|
58
|
+
print(f"{Colors.RED}❌ {text}{Colors.ENDC}")
|
|
59
|
+
|
|
60
|
+
# Complete verification suite
|
|
61
|
+
VERIFICATION_SUITE = [
|
|
62
|
+
# P0: Security (CRITICAL)
|
|
63
|
+
{
|
|
64
|
+
"category": "Security",
|
|
65
|
+
"checks": [
|
|
66
|
+
("Security Scan", ".agent/skills/vulnerability-scanner/scripts/security_scan.py", True),
|
|
67
|
+
("Dependency Analysis", ".agent/skills/vulnerability-scanner/scripts/dependency_analyzer.py", False),
|
|
68
|
+
]
|
|
69
|
+
},
|
|
70
|
+
|
|
71
|
+
# P1: Code Quality (CRITICAL)
|
|
72
|
+
{
|
|
73
|
+
"category": "Code Quality",
|
|
74
|
+
"checks": [
|
|
75
|
+
("Lint Check", ".agent/skills/lint-and-validate/scripts/lint_runner.py", True),
|
|
76
|
+
("Type Coverage", ".agent/skills/lint-and-validate/scripts/type_coverage.py", False),
|
|
77
|
+
]
|
|
78
|
+
},
|
|
79
|
+
|
|
80
|
+
# P2: Data Layer
|
|
81
|
+
{
|
|
82
|
+
"category": "Data Layer",
|
|
83
|
+
"checks": [
|
|
84
|
+
("Schema Validation", ".agent/skills/database-design/scripts/schema_validator.py", False),
|
|
85
|
+
]
|
|
86
|
+
},
|
|
87
|
+
|
|
88
|
+
# P3: Testing
|
|
89
|
+
{
|
|
90
|
+
"category": "Testing",
|
|
91
|
+
"checks": [
|
|
92
|
+
("Test Suite", ".agent/skills/testing-patterns/scripts/test_runner.py", False),
|
|
93
|
+
]
|
|
94
|
+
},
|
|
95
|
+
|
|
96
|
+
# P4: UX & Accessibility
|
|
97
|
+
{
|
|
98
|
+
"category": "UX & Accessibility",
|
|
99
|
+
"checks": [
|
|
100
|
+
("UX Audit", ".agent/skills/frontend-design/scripts/ux_audit.py", False),
|
|
101
|
+
("Accessibility Check", ".agent/skills/frontend-design/scripts/accessibility_checker.py", False),
|
|
102
|
+
]
|
|
103
|
+
},
|
|
104
|
+
|
|
105
|
+
# P5: SEO & Content
|
|
106
|
+
{
|
|
107
|
+
"category": "SEO & Content",
|
|
108
|
+
"checks": [
|
|
109
|
+
("SEO Check", ".agent/skills/seo-fundamentals/scripts/seo_checker.py", False),
|
|
110
|
+
("GEO Check", ".agent/skills/geo-fundamentals/scripts/geo_checker.py", False),
|
|
111
|
+
]
|
|
112
|
+
},
|
|
113
|
+
|
|
114
|
+
# P6: Performance (requires URL)
|
|
115
|
+
{
|
|
116
|
+
"category": "Performance",
|
|
117
|
+
"requires_url": True,
|
|
118
|
+
"checks": [
|
|
119
|
+
("Lighthouse Audit", ".agent/skills/performance-profiling/scripts/lighthouse_audit.py", True),
|
|
120
|
+
("Bundle Analysis", ".agent/skills/performance-profiling/scripts/bundle_analyzer.py", False),
|
|
121
|
+
]
|
|
122
|
+
},
|
|
123
|
+
|
|
124
|
+
# P7: E2E Testing (requires URL)
|
|
125
|
+
{
|
|
126
|
+
"category": "E2E Testing",
|
|
127
|
+
"requires_url": True,
|
|
128
|
+
"checks": [
|
|
129
|
+
("Playwright E2E", ".agent/skills/webapp-testing/scripts/playwright_runner.py", False),
|
|
130
|
+
]
|
|
131
|
+
},
|
|
132
|
+
|
|
133
|
+
# P8: Mobile (if applicable)
|
|
134
|
+
{
|
|
135
|
+
"category": "Mobile",
|
|
136
|
+
"checks": [
|
|
137
|
+
("Mobile Audit", ".agent/skills/mobile-design/scripts/mobile_audit.py", False),
|
|
138
|
+
]
|
|
139
|
+
},
|
|
140
|
+
|
|
141
|
+
# P9: Internationalization
|
|
142
|
+
{
|
|
143
|
+
"category": "Internationalization",
|
|
144
|
+
"checks": [
|
|
145
|
+
("i18n Check", ".agent/skills/i18n-localization/scripts/i18n_checker.py", False),
|
|
146
|
+
]
|
|
147
|
+
},
|
|
148
|
+
]
|
|
149
|
+
|
|
150
|
+
def run_script(name: str, script_path: Path, project_path: str, url: Optional[str] = None) -> dict:
|
|
151
|
+
"""Run validation script"""
|
|
152
|
+
if not script_path.exists():
|
|
153
|
+
print_warning(f"{name}: Script not found, skipping")
|
|
154
|
+
return {"name": name, "passed": True, "skipped": True, "duration": 0}
|
|
155
|
+
|
|
156
|
+
print_step(f"Running: {name}")
|
|
157
|
+
start_time = datetime.now()
|
|
158
|
+
|
|
159
|
+
# Build command
|
|
160
|
+
cmd = ["python", str(script_path), project_path]
|
|
161
|
+
if url and ("lighthouse" in script_path.name.lower() or "playwright" in script_path.name.lower()):
|
|
162
|
+
cmd.append(url)
|
|
163
|
+
|
|
164
|
+
# Run
|
|
165
|
+
try:
|
|
166
|
+
result = subprocess.run(
|
|
167
|
+
cmd,
|
|
168
|
+
capture_output=True,
|
|
169
|
+
text=True,
|
|
170
|
+
timeout=600 # 10 minute timeout for slow checks
|
|
171
|
+
)
|
|
172
|
+
|
|
173
|
+
duration = (datetime.now() - start_time).total_seconds()
|
|
174
|
+
passed = result.returncode == 0
|
|
175
|
+
|
|
176
|
+
if passed:
|
|
177
|
+
print_success(f"{name}: PASSED ({duration:.1f}s)")
|
|
178
|
+
else:
|
|
179
|
+
print_error(f"{name}: FAILED ({duration:.1f}s)")
|
|
180
|
+
if result.stderr:
|
|
181
|
+
print(f" {result.stderr[:300]}")
|
|
182
|
+
|
|
183
|
+
return {
|
|
184
|
+
"name": name,
|
|
185
|
+
"passed": passed,
|
|
186
|
+
"output": result.stdout,
|
|
187
|
+
"error": result.stderr,
|
|
188
|
+
"skipped": False,
|
|
189
|
+
"duration": duration
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
except subprocess.TimeoutExpired:
|
|
193
|
+
duration = (datetime.now() - start_time).total_seconds()
|
|
194
|
+
print_error(f"{name}: TIMEOUT (>{duration:.0f}s)")
|
|
195
|
+
return {"name": name, "passed": False, "skipped": False, "duration": duration, "error": "Timeout"}
|
|
196
|
+
|
|
197
|
+
except Exception as e:
|
|
198
|
+
duration = (datetime.now() - start_time).total_seconds()
|
|
199
|
+
print_error(f"{name}: ERROR - {str(e)}")
|
|
200
|
+
return {"name": name, "passed": False, "skipped": False, "duration": duration, "error": str(e)}
|
|
201
|
+
|
|
202
|
+
def print_final_report(results: List[dict], start_time: datetime):
|
|
203
|
+
"""Print comprehensive final report"""
|
|
204
|
+
total_duration = (datetime.now() - start_time).total_seconds()
|
|
205
|
+
|
|
206
|
+
print_header("📊 FULL VERIFICATION REPORT")
|
|
207
|
+
|
|
208
|
+
# Statistics
|
|
209
|
+
total = len(results)
|
|
210
|
+
passed = sum(1 for r in results if r["passed"] and not r.get("skipped"))
|
|
211
|
+
failed = sum(1 for r in results if not r["passed"] and not r.get("skipped"))
|
|
212
|
+
skipped = sum(1 for r in results if r.get("skipped"))
|
|
213
|
+
|
|
214
|
+
print(f"Total Duration: {total_duration:.1f}s")
|
|
215
|
+
print(f"Total Checks: {total}")
|
|
216
|
+
print(f"{Colors.GREEN}✅ Passed: {passed}{Colors.ENDC}")
|
|
217
|
+
print(f"{Colors.RED}❌ Failed: {failed}{Colors.ENDC}")
|
|
218
|
+
print(f"{Colors.YELLOW}⏭️ Skipped: {skipped}{Colors.ENDC}")
|
|
219
|
+
print()
|
|
220
|
+
|
|
221
|
+
# Category breakdown
|
|
222
|
+
print(f"{Colors.BOLD}Results by Category:{Colors.ENDC}")
|
|
223
|
+
current_category = None
|
|
224
|
+
for r in results:
|
|
225
|
+
# Print category header if changed
|
|
226
|
+
if r.get("category") and r["category"] != current_category:
|
|
227
|
+
current_category = r["category"]
|
|
228
|
+
print(f"\n{Colors.BOLD}{Colors.CYAN}{current_category}:{Colors.ENDC}")
|
|
229
|
+
|
|
230
|
+
# Print result
|
|
231
|
+
if r.get("skipped"):
|
|
232
|
+
status = f"{Colors.YELLOW}⏭️ {Colors.ENDC}"
|
|
233
|
+
elif r["passed"]:
|
|
234
|
+
status = f"{Colors.GREEN}✅{Colors.ENDC}"
|
|
235
|
+
else:
|
|
236
|
+
status = f"{Colors.RED}❌{Colors.ENDC}"
|
|
237
|
+
|
|
238
|
+
duration_str = f"({r.get('duration', 0):.1f}s)" if not r.get("skipped") else ""
|
|
239
|
+
print(f" {status} {r['name']} {duration_str}")
|
|
240
|
+
|
|
241
|
+
print()
|
|
242
|
+
|
|
243
|
+
# Failed checks detail
|
|
244
|
+
if failed > 0:
|
|
245
|
+
print(f"{Colors.BOLD}{Colors.RED}❌ FAILED CHECKS:{Colors.ENDC}")
|
|
246
|
+
for r in results:
|
|
247
|
+
if not r["passed"] and not r.get("skipped"):
|
|
248
|
+
print(f"\n{Colors.RED}✗ {r['name']}{Colors.ENDC}")
|
|
249
|
+
if r.get("error"):
|
|
250
|
+
error_preview = r["error"][:200]
|
|
251
|
+
print(f" Error: {error_preview}")
|
|
252
|
+
print()
|
|
253
|
+
|
|
254
|
+
# Final verdict
|
|
255
|
+
if failed > 0:
|
|
256
|
+
print_error(f"VERIFICATION FAILED - {failed} check(s) need attention")
|
|
257
|
+
print(f"\n{Colors.YELLOW}💡 Tip: Fix critical (security, lint) issues first{Colors.ENDC}")
|
|
258
|
+
return False
|
|
259
|
+
else:
|
|
260
|
+
print_success("✨ ALL CHECKS PASSED - Ready for deployment! ✨")
|
|
261
|
+
return True
|
|
262
|
+
|
|
263
|
+
def main():
|
|
264
|
+
parser = argparse.ArgumentParser(
|
|
265
|
+
description="Run complete Antigravity Kit verification suite",
|
|
266
|
+
formatter_class=argparse.RawDescriptionHelpFormatter,
|
|
267
|
+
epilog="""
|
|
268
|
+
Examples:
|
|
269
|
+
python scripts/verify_all.py . --url http://localhost:3000
|
|
270
|
+
python scripts/verify_all.py . --url https://staging.example.com --no-e2e
|
|
271
|
+
"""
|
|
272
|
+
)
|
|
273
|
+
parser.add_argument("project", help="Project path to validate")
|
|
274
|
+
parser.add_argument("--url", required=True, help="URL for performance & E2E checks")
|
|
275
|
+
parser.add_argument("--no-e2e", action="store_true", help="Skip E2E tests")
|
|
276
|
+
parser.add_argument("--stop-on-fail", action="store_true", help="Stop on first failure")
|
|
277
|
+
|
|
278
|
+
args = parser.parse_args()
|
|
279
|
+
|
|
280
|
+
project_path = Path(args.project).resolve()
|
|
281
|
+
|
|
282
|
+
if not project_path.exists():
|
|
283
|
+
print_error(f"Project path does not exist: {project_path}")
|
|
284
|
+
sys.exit(1)
|
|
285
|
+
|
|
286
|
+
print_header("🚀 ANTIGRAVITY KIT - FULL VERIFICATION SUITE")
|
|
287
|
+
print(f"Project: {project_path}")
|
|
288
|
+
print(f"URL: {args.url}")
|
|
289
|
+
print(f"Started: {datetime.now().strftime('%Y-%m-%d %H:%M:%S')}")
|
|
290
|
+
|
|
291
|
+
start_time = datetime.now()
|
|
292
|
+
results = []
|
|
293
|
+
|
|
294
|
+
# Run all verification categories
|
|
295
|
+
for suite in VERIFICATION_SUITE:
|
|
296
|
+
category = suite["category"]
|
|
297
|
+
requires_url = suite.get("requires_url", False)
|
|
298
|
+
|
|
299
|
+
# Skip if requires URL and not provided
|
|
300
|
+
if requires_url and not args.url:
|
|
301
|
+
continue
|
|
302
|
+
|
|
303
|
+
# Skip E2E if flag set
|
|
304
|
+
if args.no_e2e and category == "E2E Testing":
|
|
305
|
+
continue
|
|
306
|
+
|
|
307
|
+
print_header(f"📋 {category.upper()}")
|
|
308
|
+
|
|
309
|
+
for name, script_path, required in suite["checks"]:
|
|
310
|
+
script = project_path / script_path
|
|
311
|
+
result = run_script(name, script, str(project_path), args.url)
|
|
312
|
+
result["category"] = category
|
|
313
|
+
results.append(result)
|
|
314
|
+
|
|
315
|
+
# Stop on critical failure if flag set
|
|
316
|
+
if args.stop_on_fail and required and not result["passed"] and not result.get("skipped"):
|
|
317
|
+
print_error(f"CRITICAL: {name} failed. Stopping verification.")
|
|
318
|
+
print_final_report(results, start_time)
|
|
319
|
+
sys.exit(1)
|
|
320
|
+
|
|
321
|
+
# Print final report
|
|
322
|
+
all_passed = print_final_report(results, start_time)
|
|
323
|
+
|
|
324
|
+
sys.exit(0 if all_passed else 1)
|
|
325
|
+
|
|
326
|
+
if __name__ == "__main__":
|
|
327
|
+
main()
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: api-patterns
|
|
3
|
+
description: API design principles and decision-making. REST vs GraphQL vs tRPC selection, response formats, versioning, pagination.
|
|
4
|
+
allowed-tools: Read, Write, Edit, Glob, Grep
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# API Patterns
|
|
8
|
+
|
|
9
|
+
> API design principles and decision-making for 2025.
|
|
10
|
+
> **Learn to THINK, not copy fixed patterns.**
|
|
11
|
+
|
|
12
|
+
## 🎯 Selective Reading Rule
|
|
13
|
+
|
|
14
|
+
**Read ONLY files relevant to the request!** Check the content map, find what you need.
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 📑 Content Map
|
|
19
|
+
|
|
20
|
+
| File | Description | When to Read |
|
|
21
|
+
|------|-------------|--------------|
|
|
22
|
+
| `api-style.md` | REST vs GraphQL vs tRPC decision tree | Choosing API type |
|
|
23
|
+
| `rest.md` | Resource naming, HTTP methods, status codes | Designing REST API |
|
|
24
|
+
| `response.md` | Envelope pattern, error format, pagination | Response structure |
|
|
25
|
+
| `graphql.md` | Schema design, when to use, security | Considering GraphQL |
|
|
26
|
+
| `trpc.md` | TypeScript monorepo, type safety | TS fullstack projects |
|
|
27
|
+
| `versioning.md` | URI/Header/Query versioning | API evolution planning |
|
|
28
|
+
| `auth.md` | JWT, OAuth, Passkey, API Keys | Auth pattern selection |
|
|
29
|
+
| `rate-limiting.md` | Token bucket, sliding window | API protection |
|
|
30
|
+
| `documentation.md` | OpenAPI/Swagger best practices | Documentation |
|
|
31
|
+
| `security-testing.md` | OWASP API Top 10, auth/authz testing | Security audits |
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 🔗 Related Skills
|
|
36
|
+
|
|
37
|
+
| Need | Skill |
|
|
38
|
+
|------|-------|
|
|
39
|
+
| API implementation | `@[skills/backend-development]` |
|
|
40
|
+
| Data structure | `@[skills/database-design]` |
|
|
41
|
+
| Security details | `@[skills/security-hardening]` |
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
## ✅ Decision Checklist
|
|
46
|
+
|
|
47
|
+
Before designing an API:
|
|
48
|
+
|
|
49
|
+
- [ ] **Asked user about API consumers?**
|
|
50
|
+
- [ ] **Chosen API style for THIS context?** (REST/GraphQL/tRPC)
|
|
51
|
+
- [ ] **Defined consistent response format?**
|
|
52
|
+
- [ ] **Planned versioning strategy?**
|
|
53
|
+
- [ ] **Considered authentication needs?**
|
|
54
|
+
- [ ] **Planned rate limiting?**
|
|
55
|
+
- [ ] **Documentation approach defined?**
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## ❌ Anti-Patterns
|
|
60
|
+
|
|
61
|
+
**DON'T:**
|
|
62
|
+
- Default to REST for everything
|
|
63
|
+
- Use verbs in REST endpoints (/getUsers)
|
|
64
|
+
- Return inconsistent response formats
|
|
65
|
+
- Expose internal errors to clients
|
|
66
|
+
- Skip rate limiting
|
|
67
|
+
|
|
68
|
+
**DO:**
|
|
69
|
+
- Choose API style based on context
|
|
70
|
+
- Ask about client requirements
|
|
71
|
+
- Document thoroughly
|
|
72
|
+
- Use appropriate status codes
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Script
|
|
77
|
+
|
|
78
|
+
| Script | Purpose | Command |
|
|
79
|
+
|--------|---------|---------|
|
|
80
|
+
| `scripts/api_validator.py` | API endpoint validation | `python scripts/api_validator.py <project_path>` |
|
|
81
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# API Style Selection (2025)
|
|
2
|
+
|
|
3
|
+
> REST vs GraphQL vs tRPC - Hangi durumda hangisi?
|
|
4
|
+
|
|
5
|
+
## Decision Tree
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Who are the API consumers?
|
|
9
|
+
│
|
|
10
|
+
├── Public API / Multiple platforms
|
|
11
|
+
│ └── REST + OpenAPI (widest compatibility)
|
|
12
|
+
│
|
|
13
|
+
├── Complex data needs / Multiple frontends
|
|
14
|
+
│ └── GraphQL (flexible queries)
|
|
15
|
+
│
|
|
16
|
+
├── TypeScript frontend + backend (monorepo)
|
|
17
|
+
│ └── tRPC (end-to-end type safety)
|
|
18
|
+
│
|
|
19
|
+
├── Real-time / Event-driven
|
|
20
|
+
│ └── WebSocket + AsyncAPI
|
|
21
|
+
│
|
|
22
|
+
└── Internal microservices
|
|
23
|
+
└── gRPC (performance) or REST (simplicity)
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Comparison
|
|
27
|
+
|
|
28
|
+
| Factor | REST | GraphQL | tRPC |
|
|
29
|
+
|--------|------|---------|------|
|
|
30
|
+
| **Best for** | Public APIs | Complex apps | TS monorepos |
|
|
31
|
+
| **Learning curve** | Low | Medium | Low (if TS) |
|
|
32
|
+
| **Over/under fetching** | Common | Solved | Solved |
|
|
33
|
+
| **Type safety** | Manual (OpenAPI) | Schema-based | Automatic |
|
|
34
|
+
| **Caching** | HTTP native | Complex | Client-based |
|
|
35
|
+
|
|
36
|
+
## Selection Questions
|
|
37
|
+
|
|
38
|
+
1. Who are the API consumers?
|
|
39
|
+
2. Is the frontend TypeScript?
|
|
40
|
+
3. How complex are the data relationships?
|
|
41
|
+
4. Is caching critical?
|
|
42
|
+
5. Public or internal API?
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Authentication Patterns
|
|
2
|
+
|
|
3
|
+
> Choose auth pattern based on use case.
|
|
4
|
+
|
|
5
|
+
## Selection Guide
|
|
6
|
+
|
|
7
|
+
| Pattern | Best For |
|
|
8
|
+
|---------|----------|
|
|
9
|
+
| **JWT** | Stateless, microservices |
|
|
10
|
+
| **Session** | Traditional web, simple |
|
|
11
|
+
| **OAuth 2.0** | Third-party integration |
|
|
12
|
+
| **API Keys** | Server-to-server, public APIs |
|
|
13
|
+
| **Passkey** | Modern passwordless (2025+) |
|
|
14
|
+
|
|
15
|
+
## JWT Principles
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
Important:
|
|
19
|
+
├── Always verify signature
|
|
20
|
+
├── Check expiration
|
|
21
|
+
├── Include minimal claims
|
|
22
|
+
├── Use short expiry + refresh tokens
|
|
23
|
+
└── Never store sensitive data in JWT
|
|
24
|
+
```
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# API Documentation Principles
|
|
2
|
+
|
|
3
|
+
> Good docs = happy developers = API adoption.
|
|
4
|
+
|
|
5
|
+
## OpenAPI/Swagger Essentials
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Include:
|
|
9
|
+
├── All endpoints with examples
|
|
10
|
+
├── Request/response schemas
|
|
11
|
+
├── Authentication requirements
|
|
12
|
+
├── Error response formats
|
|
13
|
+
└── Rate limiting info
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Good Documentation Has
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
Essentials:
|
|
20
|
+
├── Quick start / Getting started
|
|
21
|
+
├── Authentication guide
|
|
22
|
+
├── Complete API reference
|
|
23
|
+
├── Error handling guide
|
|
24
|
+
├── Code examples (multiple languages)
|
|
25
|
+
└── Changelog
|
|
26
|
+
```
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# GraphQL Principles
|
|
2
|
+
|
|
3
|
+
> Flexible queries for complex, interconnected data.
|
|
4
|
+
|
|
5
|
+
## When to Use
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
✅ Good fit:
|
|
9
|
+
├── Complex, interconnected data
|
|
10
|
+
├── Multiple frontend platforms
|
|
11
|
+
├── Clients need flexible queries
|
|
12
|
+
├── Evolving data requirements
|
|
13
|
+
└── Reducing over-fetching matters
|
|
14
|
+
|
|
15
|
+
❌ Poor fit:
|
|
16
|
+
├── Simple CRUD operations
|
|
17
|
+
├── File upload heavy
|
|
18
|
+
├── HTTP caching important
|
|
19
|
+
└── Team unfamiliar with GraphQL
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Schema Design Principles
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
Principles:
|
|
26
|
+
├── Think in graphs, not endpoints
|
|
27
|
+
├── Design for evolvability (no versions)
|
|
28
|
+
├── Use connections for pagination
|
|
29
|
+
├── Be specific with types (not generic "data")
|
|
30
|
+
└── Handle nullability thoughtfully
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Security Considerations
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
Protect against:
|
|
37
|
+
├── Query depth attacks → Set max depth
|
|
38
|
+
├── Query complexity → Calculate cost
|
|
39
|
+
├── Batching abuse → Limit batch size
|
|
40
|
+
├── Introspection → Disable in production
|
|
41
|
+
```
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Rate Limiting Principles
|
|
2
|
+
|
|
3
|
+
> Protect your API from abuse and overload.
|
|
4
|
+
|
|
5
|
+
## Why Rate Limit
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Protect against:
|
|
9
|
+
├── Brute force attacks
|
|
10
|
+
├── Resource exhaustion
|
|
11
|
+
├── Cost overruns (if pay-per-use)
|
|
12
|
+
└── Unfair usage
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Strategy Selection
|
|
16
|
+
|
|
17
|
+
| Type | How | When |
|
|
18
|
+
|------|-----|------|
|
|
19
|
+
| **Token bucket** | Burst allowed, refills over time | Most APIs |
|
|
20
|
+
| **Sliding window** | Smooth distribution | Strict limits |
|
|
21
|
+
| **Fixed window** | Simple counters per window | Basic needs |
|
|
22
|
+
|
|
23
|
+
## Response Headers
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
Include in headers:
|
|
27
|
+
├── X-RateLimit-Limit (max requests)
|
|
28
|
+
├── X-RateLimit-Remaining (requests left)
|
|
29
|
+
├── X-RateLimit-Reset (when limit resets)
|
|
30
|
+
└── Return 429 when exceeded
|
|
31
|
+
```
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Response Format Principles
|
|
2
|
+
|
|
3
|
+
> Consistency is key - choose a format and stick to it.
|
|
4
|
+
|
|
5
|
+
## Common Patterns
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Choose one:
|
|
9
|
+
├── Envelope pattern ({ success, data, error })
|
|
10
|
+
├── Direct data (just return the resource)
|
|
11
|
+
└── HAL/JSON:API (hypermedia)
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Error Response
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
Include:
|
|
18
|
+
├── Error code (for programmatic handling)
|
|
19
|
+
├── User message (for display)
|
|
20
|
+
├── Details (for debugging, field-level errors)
|
|
21
|
+
├── Request ID (for support)
|
|
22
|
+
└── NOT internal details (security!)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Pagination Types
|
|
26
|
+
|
|
27
|
+
| Type | Best For | Trade-offs |
|
|
28
|
+
|------|----------|------------|
|
|
29
|
+
| **Offset** | Simple, jumpable | Performance on large datasets |
|
|
30
|
+
| **Cursor** | Large datasets | Can't jump to page |
|
|
31
|
+
| **Keyset** | Performance critical | Requires sortable key |
|
|
32
|
+
|
|
33
|
+
### Selection Questions
|
|
34
|
+
|
|
35
|
+
1. How large is the dataset?
|
|
36
|
+
2. Do users need to jump to specific pages?
|
|
37
|
+
3. Is data frequently changing?
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# REST Principles
|
|
2
|
+
|
|
3
|
+
> Resource-based API design - nouns not verbs.
|
|
4
|
+
|
|
5
|
+
## Resource Naming Rules
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
Principles:
|
|
9
|
+
├── Use NOUNS, not verbs (resources, not actions)
|
|
10
|
+
├── Use PLURAL forms (/users not /user)
|
|
11
|
+
├── Use lowercase with hyphens (/user-profiles)
|
|
12
|
+
├── Nest for relationships (/users/123/posts)
|
|
13
|
+
└── Keep shallow (max 3 levels deep)
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## HTTP Method Selection
|
|
17
|
+
|
|
18
|
+
| Method | Purpose | Idempotent? | Body? |
|
|
19
|
+
|--------|---------|-------------|-------|
|
|
20
|
+
| **GET** | Read resource(s) | Yes | No |
|
|
21
|
+
| **POST** | Create new resource | No | Yes |
|
|
22
|
+
| **PUT** | Replace entire resource | Yes | Yes |
|
|
23
|
+
| **PATCH** | Partial update | No | Yes |
|
|
24
|
+
| **DELETE** | Remove resource | Yes | No |
|
|
25
|
+
|
|
26
|
+
## Status Code Selection
|
|
27
|
+
|
|
28
|
+
| Situation | Code | Why |
|
|
29
|
+
|-----------|------|-----|
|
|
30
|
+
| Success (read) | 200 | Standard success |
|
|
31
|
+
| Created | 201 | New resource created |
|
|
32
|
+
| No content | 204 | Success, nothing to return |
|
|
33
|
+
| Bad request | 400 | Malformed request |
|
|
34
|
+
| Unauthorized | 401 | Missing/invalid auth |
|
|
35
|
+
| Forbidden | 403 | Valid auth, no permission |
|
|
36
|
+
| Not found | 404 | Resource doesn't exist |
|
|
37
|
+
| Conflict | 409 | State conflict (duplicate) |
|
|
38
|
+
| Validation error | 422 | Valid syntax, invalid data |
|
|
39
|
+
| Rate limited | 429 | Too many requests |
|
|
40
|
+
| Server error | 500 | Our fault |
|