Back to Skills

rest-api

KubrickCode
Updated Today
83 views
1
1
View on GitHub
Testingwordapidesign

About

This skill provides comprehensive REST API design standards and implementation guidance for developers. It covers essential patterns including URL structure, HTTP methods, status codes, pagination, filtering, error handling, and API versioning. Use it when designing API endpoints, implementing consistent response structures, or documenting APIs with OpenAPI/Swagger.

Documentation

REST API Design Standards

Naming Conventions

Field Naming

  • Boolean: Require is/has/can prefix
  • Date: Require ~At suffix
  • Use consistent terminology throughout the project (unify on either "create" or "add")

Date Format

  • ISO 8601 UTC
  • Use DateTime type

Pagination

Cursor-Based (Industry Standard)

  • Parameters: ?cursor=xyz&limit=20
  • Response: { data: [...], nextCursor: "abc", hasNext: true }

Sorting

  • ?sortBy=createdAt&sortOrder=desc
  • Support multiple sort
  • Specify defaults

Filtering

  • Range: { min, max } or { gte, lte }
  • Complex conditions use nested objects

URL Structure

Nested Resources

  • Maximum 2 levels

Actions

  • Allow verbs only when unable to represent as resource
  • /users/:id/activate

Response

List

  • data + pagination info

Creation

  • 201 + resource (excluding sensitive information)

Error (RFC 7807 ProblemDetail)

  • Required: type, title, status, detail, instance
  • Optional: errors array

Batch

  • /batch suffix
  • Success/failure count + results

Quick Install

/plugin add https://github.com/KubrickCode/ai-config-toolkit/tree/main/rest-api

Copy and paste this command in Claude Code to install this skill

GitHub 仓库

KubrickCode/ai-config-toolkit
Path: .claude/skills/rest-api

Related Skills

evaluating-llms-harness

Testing

This Claude Skill runs the lm-evaluation-harness to benchmark LLMs across 60+ standardized academic tasks like MMLU and GSM8K. It's designed for developers to compare model quality, track training progress, or report academic results. The tool supports various backends including HuggingFace and vLLM models.

View skill

langchain

Meta

LangChain is a framework for building LLM applications using agents, chains, and RAG pipelines. It supports multiple LLM providers, offers 500+ integrations, and includes features like tool calling and memory management. Use it for rapid prototyping and deploying production systems like chatbots, autonomous agents, and question-answering services.

View skill

webapp-testing

Testing

This Claude Skill provides a Playwright-based toolkit for testing local web applications through Python scripts. It enables frontend verification, UI debugging, screenshot capture, and log viewing while managing server lifecycles. Use it for browser automation tasks but run scripts directly rather than reading their source code to avoid context pollution.

View skill

business-rule-documentation

Meta

This skill provides standardized templates for systematically documenting business logic and domain knowledge following Domain-Driven Design principles. It helps developers capture business rules, process flows, decision trees, and terminology glossaries to maintain consistency between requirements and implementation. Use it when documenting domain models, creating business rule repositories, or bridging communication between business and technical teams.

View skill