Communitygithub.com

aj-geddes/rest-api-design

Entwerfen Sie RESTful-APIs nach Best Practices für Ressourcenmodellierung, HTTP-Methoden, Statuscodes, Versionierung und Dokumentation. Verwenden Sie dies beim Erstellen neuer APIs, Entwerfen von Endpunkten oder Verbessern bestehender API-Architektur.

Was ist rest-api-design?

Dieses Skill unterstützt Entwickler und KI-Agenten bei der Gestaltung von RESTful-APIs, die den etablierten Best Practices der Branche folgen. Es umfasst die Kernprinzipien der Ressourcenmodellierung, die korrekte Verwendung von HTTP-Methoden (GET, POST, PUT, DELETE, PATCH), die Auswahl angemessener Statuscodes für verschiedene Szenarien, die API-Versionierung (z.B. über URL-Pfade oder Header) sowie die Erstellung einer vollständigen und verständlichen API-Dokumentation. Der Skill ist plattformunabhängig und kann in verschiedenen Entwicklungsumgebungen wie Claude Code, Cursor oder Codex eingesetzt werden. Er hilft dabei, konsistente und wartbare Schnittstellen zu entwerfen, die leicht von anderen Entwicklern und Systemen genutzt werden können. Durch die Berücksichtigung dieser Best Practices wird die Interoperabilität, Skalierbarkeit und Wartbarkeit der API erheblich verbessert.

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

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Was macht rest-api-design?

Entwerfen Sie RESTful-APIs nach Best Practices für Ressourcenmodellierung, HTTP-Methoden, Statuscodes, Versionierung und Dokumentation. Verwenden Sie dies beim Erstellen neuer APIs, Entwerfen von Endpunkten oder Verbessern bestehender API-Architektur.

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.

Verwandte Skills