skills.rest
authgear
authgearOFFICIAL
Explore all skills by this author →
Website𝕏@authgearGitHub

api_design

Evaluate and ideate Authgear API designs against a documented checklist.

2.0k|126|Updated Jun 16, 2020
Search Tags:#checklist#ideation#graphql#api-design#http-api#authgear#config-review
One-click install
npx skills add https://github.com/authgear/authgear-server --skill api-design-authgear
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api_design
Source: https://github.com/authgear/authgear-server/tree/main/.claude/skills/api_design
Command: npx skills add https://github.com/authgear/authgear-server --skill api-design-authgear

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents inconsistent or incomplete Authgear API changes by guiding developers through a checklist-driven review or ideation process so every config, GraphQL, HTTP, or authflow addition meets platform expectations.

Core Features & Use Cases

  • Checklist-driven review: Intakes existing drafts to verify naming, config schema, pagination, error handling, and backward compatibility before merging.
  • Ideation assistance: Translates feature descriptions into concrete config YAML, GraphQL SDL, or HTTP endpoint specs along with a self-review against the same checklist.
  • Use Case: When adding a new authentication flow, describe the desired behavior and receive both the API definition and a review that highlights any deviations from Authgear conventions.

Quick Start

Submit your Authgear API draft or describe the feature you need so the skill can produce or review a compliant design.

Frequently Asked Questions about api_design

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

FAQPage Schema
How do I review an Authgear HTTP API design for naming and backward compatibility?▼

Submit your Authgear HTTP API draft to evaluate naming conventions, config schema, pagination, error handling, and backward compatibility against the platform's documented checklist requirements before merging.

What is the best way to ideate a new GraphQL admin API for Authgear authentication features?▼

Describe the desired authentication behavior to receive concrete GraphQL SDL definitions and config YAML, along with a self-review against Authgear API checklist conventions for consistent architecture.

Does this API design checklist support Authgear authflow surfaces?▼

Yes, the API design checklist supports Authgear authflow surfaces, validating configuration, HTTP, and GraphQL admin APIs for authentication and user management features to ensure platform compliance.

How do I generate a compliant config schema when adding a new authentication flow?▼

Describe your new authentication flow feature to produce concrete config YAML definitions and receive a checklist review highlighting any deviations from Authgear conventions before implementation.

Why does my Authgear API draft fail the config review checklist?▼

Your Authgear API draft may fail the config review checklist due to non-compliant naming, invalid config schema, improper pagination, inconsistent error handling, or backward compatibility violations defined by the documentation.

Related Skills

Explore More Software Engineering Skills→
qdzshqdzsh
12

api-design

Design HTTP or GraphQL API contracts with endpoints, methods, and error models.

Community
Advanced
Vivekmano27Vivekmano27

api-designer

Create standards-compliant REST and GraphQL API specifications in OpenAPI YAML or Markdown.

Community
Advanced
JaiminVadadoriyaJaiminVadadoriya
1

api-testing

Automate REST and GraphQL API tests with schema validation and authentication.

Community
Advanced
ignidusignidus

api-design

Standardize REST API naming, HTTP semantics, pagination, and versioning rules.

Official
Advanced