Communitygithub.com

aj-geddes/rest-api-design

根據最佳實踐設計 RESTful API,涵蓋資源建模、HTTP 方法、狀態碼、版本控制和文件。用於建立新 API、設計端點或改善現有 API 架構。

rest-api-design 是什麼?

這個技能提供設計 RESTful API 的結構化方法,遵循業界最佳實踐。它涵蓋關鍵領域,如資源建模、HTTP 方法、狀態碼、版本控制和文件。該技能可與流行的 AI 代理平台一起使用,包括 Claude Code、Cursor 和 Codex。它提供逐步指導來建立新 API、設計端點或改善現有 API 架構。通過實施一致的命名約定、適當的 HTTP 動詞和語義狀態碼,開發人員可以建立可擴展且可維護的 API。文件指南確保 API 易於使用者理解和使用。該技能旨在簡化 API 設計過程,促進程式碼庫和團隊之間的一致性。

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

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

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.

相關技能