api-lifecycle

Establish API lifecycle practices for REST and GraphQL APIs.

3|Updated Feb 2, 2026
One-click install
npx skills add https://github.com/doancan/mags --skill api-lifecycle
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-lifecycle
Source: https://github.com/doancan/mags/tree/main/skills/api-lifecycle
Command: npx skills add https://github.com/doancan/mags --skill api-lifecycle

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

APIs drift when versioning, deprecation timelines, and documentation lacking consistency. This skill provides a structured approach to design, govern, and evolve APIs with predictable lifecycles across REST and GraphQL.

Core Features & Use Cases

  • Versioning strategies: URL path versioning, header versioning, and transition plans.
  • Deprecation processes: 5-step deprecation workflow including announcement, marking, monitoring, sunset, and removal.
  • Rate limiting guidelines: recommended strategies and typical quotas per tier.
  • Documentation standards: OpenAPI 3.1 documentation and changelog requirements.
  • Use Cases: Plan lifecycle for new services and maintain existing APIs through evolution.

Quick Start

Apply this skill to plan an API lifecycle for a new REST service, outlining versioning, deprecation, rate limiting, and OpenAPI documentation requirements.

Frequently Asked Questions about api-lifecycle

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I manage API versioning and deprecation for REST and GraphQL services?

Manage API versioning by applying URL path or header versioning strategies, and handle deprecation using a 5-step workflow encompassing announcement, marking, monitoring, sunset, and removal for both REST and GraphQL APIs.

What is the best way to document API lifecycles and maintain changelog consistency?

The best way to document API lifecycles is by adhering to OpenAPI 3.1 documentation standards and enforcing strict changelog requirements, ensuring predictable API evolution and consistent technical specifications across services.

How do I establish rate limiting guidelines for API tiers?

Establish rate limiting guidelines by defining recommended rate-limiting strategies and applying typical quota thresholds per API access tier, ensuring predictable consumption patterns and protecting platform infrastructure from excessive load.

Does this API lifecycle governance approach support error handling with RFC 7807?

Yes, this API lifecycle governance approach explicitly specifies technical requirements for error handling using RFC 7807, ensuring standardized problem details for HTTP APIs across REST and GraphQL workflows.

What is the standard API deprecation process from announcement to removal?

The standard API deprecation process is a 5-step workflow: formally announcing the deprecation, marking the endpoints as deprecated, monitoring remaining usage, executing the sunset phase, and finally removing the API endpoints.

Can I use this to plan the lifecycle for a new API service?

Yes, you can plan the complete lifecycle for a new API service by outlining versioning, deprecation, rate limiting, and OpenAPI documentation requirements, establishing governance from initial design through sunset.