skills.rest
langgenius
langgeniusOFFICIAL
Explore all skills by this author →
Website𝕏@dify_aiGitHub

dify-docs-api-reference

Validate Dify OpenAPI reference specs against implementation code.

175|388|Updated Mar 11, 2025
Search Tags:#error handling#openapi#rest api#api documentation#code verification#dify#spec auditing
One-click install
npx skills add https://github.com/langgenius/dify-docs --skill dify-docs-api-reference
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dify-docs-api-reference
Source: https://github.com/langgenius/dify-docs/tree/main/.claude/skills/dify-docs-api-reference
Command: npx skills add https://github.com/langgenius/dify-docs --skill dify-docs-api-reference

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps you edit or audit Dify API reference documentation without guessing, drifting from the code, or publishing inaccurate OpenAPI details. It is designed for work where parameter rules, response bodies, status codes, and error behavior must match the implementation exactly.

Core Features & Use Cases

  • Code-Verified OpenAPI Editing: Guides you to validate every documented field, enum, constraint, and response against the Dify codebase.
  • API Audit Workflow: Provides a structured checklist for reviewing existing specs, spotting missing endpoints, phantom errors, and app-type mismatches.
  • Documentation Consistency Rules: Enforces conventions for summaries, operationIds, descriptions, examples, schemas, and error formatting across Dify API specs.
  • Use Case: When updating a chat, workflow, or knowledge base endpoint in the Dify docs, use this Skill to trace the controller, service logic, converters, and exception handlers before changing the OpenAPI JSON.

Quick Start

Use the dify-docs-api-reference skill to audit or update a Dify OpenAPI spec by verifying every endpoint detail against the matching Service API controller and error handlers in the codebase.

Frequently Asked Questions about dify-docs-api-reference

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

FAQPage Schema
How do I verify Dify OpenAPI specs against the implementation code?▼

To verify Dify OpenAPI specs, trace parameter rules, response bodies, and status codes through controllers, services, converters, and global exception handlers to ensure documentation matches the codebase exactly.

What is the best way to audit Dify API reference documentation for errors?▼

Auditing Dify API reference documentation requires a structured checklist to spot missing endpoints, phantom errors, app-type mismatches, and schema constraint violations across chat, workflow, and knowledge APIs.

How do I update Dify REST API documentation without drifting from the code?▼

Updating Dify REST API docs safely involves validating OpenAPI JSON fields, enums, constraints, and examples by tracing the matching Service API controller and error handlers before publishing.

Does Dify API spec editing require code-traceable validation for error handling?▼

Yes, Dify API spec editing requires code-traceable validation of error codes and exception behavior through global handlers to ensure documented responses match actual implementation constraints.

Can I use this approach to check OpenAPI parameters for chatflow and completion endpoints?▼

Yes, you can check OpenAPI parameters for chatflow and completion endpoints by verifying app-type scope, schema constraints, and response details against the Dify codebase implementation logic.

What are common limitations when manually editing OpenAPI JSON for Dify APIs?▼

Manually editing OpenAPI JSON risks publishing inaccurate parameter rules, phantom errors, and app-type mismatches if summaries, operationIds, and error formatting are not validated against the codebase.

Related Skills

Explore More Software Engineering Skills→
MaciWPMaciWP
1

django-architecture-enforcer

Enforce three-layer Django/DRF architecture by detecting violations in views and services.

Community
Advanced
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
Muath2000Muath2000

api-contracts-auditor

Audit OpenAPI specifications against Zod DTO schemas for endpoint parity.

Community
Advanced
OpenLaborOpenLabor
4

API Design

Design RESTful APIs with OpenAPI documentation, versioning, pagination, and error codes.

Official
Intermediate