Communitygithub.com

aj-geddes/rest-api-design

RESTful API를 리소스 모델링, HTTP 메서드, 상태 코드, 버전 관리 및 문서화에 대한 모범 사례에 따라 설계합니다. 새로운 API를 만들거나, 엔드포인트를 설계하거나, 기존 API 아키텍처를 개선할 때 사용하세요.

rest-api-design란 무엇인가요?

이 스킬은 RESTful API 설계를 위한 포괄적인 가이드를 제공합니다. 리소스 모델링, 적절한 HTTP 메서드(GET, POST, PUT, DELETE 등) 사용, 의미 있는 상태 코드 반환, API 버전 관리 전략, 그리고 명확한 문서화 방법을 포함한 업계 모범 사례를 다룹니다. 새로운 API를 처음부터 설계하거나 기존 API의 아키텍처를 개선해야 할 때 특히 유용합니다. 주요 사용 사례로는 새로운 마이크로서비스 API 정의, 기존 엔드포인트의 일관성 및 확장성 개선, 또는 팀 전체의 API 설계 표준화가 있습니다. AI 어시스턴트(예: Claude Code)와 함께 사용하면 개발자가 일관되고 유지보수 가능하며 확장 가능한 API를 신속하게 설계할 수 있도록 돕습니다.

지원 대상~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/aj-geddes/useful-ai-prompts/tree/main/skills/rest-api-design

즐겨 사용하는 AI에게 물어보기

이 에이전트 스킬이 미리 로드된 새 채팅을 엽니다.

문서

rest-api-design은(는) 무엇을 하나요?

RESTful API를 리소스 모델링, HTTP 메서드, 상태 코드, 버전 관리 및 문서화에 대한 모범 사례에 따라 설계합니다. 새로운 API를 만들거나, 엔드포인트를 설계하거나, 기존 API 아키텍처를 개선할 때 사용하세요.

Individual skills in this repo

This repo contains 11 individual skills — each has its own dedicated page.

aj-geddes/android-kotlin-development

Develop native Android apps with Kotlin. Covers MVVM with Jetpack, Compose for modern UI, Retrofit for API calls, Room for local storage, and navigation architecture.

aj-geddes/ansible-automation

Infrastructure automation and configuration management using Ansible playbooks, roles, and inventory. Use for deploying applications, patching, and managing servers.

aj-geddes/architecture-diagrams

Create system architecture diagrams using Mermaid, PlantUML, C4 model, flowcharts, and sequence diagrams. Use when documenting architecture, system design, data flows, or technical workflows.

aj-geddes/code-review-analysis

Perform comprehensive code reviews with best practices, security checks, and constructive feedback. Use when reviewing pull requests, analyzing code quality, checking for security vulnerabilities, or providing code improvement suggestions.

aj-geddes/flask-api-development

Develop lightweight Flask APIs with routing, blueprints, database integration, authentication, and request/response handling. Use when building RESTful APIs, microservices, or lightweight web services with Flask.

aj-geddes/ios-swift-development

Develop native iOS apps with Swift. Covers MVVM architecture, SwiftUI, URLSession for networking, Combine for reactive programming, and Core Data persistence.

aj-geddes/jenkins-pipeline

Build Jenkins declarative and scripted pipelines with stages, agents, parameters, and plugins. Implement multi-branch pipelines and deployment automation.

aj-geddes/markdown-documentation

Master markdown formatting, GitHub Flavored Markdown, README files, and documentation formatting. Use when writing markdown docs, READMEs, or formatting documentation.

aj-geddes/nginx-configuration

Configure Nginx web server for high-performance reverse proxy, load balancing, SSL/TLS, caching, and API gateway functionality.

aj-geddes/nodejs-express-server

Build production-ready Express.js servers with middleware, authentication, routing, and database integration. Use when creating REST APIs, managing requests/responses, implementing middleware chains, and handling server logic.

aj-geddes/wireframe-prototyping

Create wireframes and interactive prototypes to visualize user interfaces and gather feedback early. Use tools and techniques to communicate design ideas before development.

관련 스킬