weiran-openapi-writer

Generate and dry-run audit OpenAPI PHP Attributes for Laravel API controllers.

3|Updated Apr 2, 2026
One-click install
npx skills add https://github.com/weiran-tech/agent-skills --skill weiran-openapi-writer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: weiran-openapi-writer
Source: https://github.com/weiran-tech/agent-skills/tree/main/skills/weiran-openapi-writer
Command: npx skills add https://github.com/weiran-tech/agent-skills --skill weiran-openapi-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

The Weiran OpenAPI Writer generates or dry-run audits of OpenAPI (Swagger) PHP Attributes for Weiran Framework / Laravel API controllers. It focuses on interface-level evidence chains and documentation modeling, addressing route-driven APIs, Request/ResponseBody reuse, header contracts, and multi-input sources analysis, while not covering project-level code quality or architecture reviews.

Core Features & Use Cases

  • Generate or dry-run OpenAPI PHP 8 Attributes for API controllers based on real route/controller/request/response structures.
  • Validate route prefixes, input sources, and response envelopes to ensure auditable OpenAPI artifacts.
  • Use in scenarios involving headers, file uploads, and multiple input modalities; supports infused QA analysis.

Quick Start

Describe the target API and ask the skill to generate or dry-run the corresponding OpenAPI attributes.

Frequently Asked Questions about weiran-openapi-writer

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

FAQPage Schema
How do I generate OpenAPI documentation for Laravel controllers using PHP 8 attributes?

OpenAPI documentation for Laravel controllers is generated by analyzing route-driven controllers, Request/Response contracts, and header rules to produce auditable PHP 8 attributes. This skill automates that extraction directly from your Weiran API codebase.

Can I audit OpenAPI attributes without modifying my source code?

Yes, you can audit OpenAPI attributes without modifying source code by using the safe dry-run workflow. This validates route prefixes, input sources, and response schemas to ensure your documentation matches your actual API structure.

Does this work with multi-source inputs and file uploads in Laravel APIs?

Multi-source inputs and file uploads in Laravel APIs are fully supported during documentation generation. The skill analyzes various input modalities and header contracts to build accurate OpenAPI request schemas.

What is the best way to validate route prefixes and response envelopes for OpenAPI?

Validating route prefixes and response envelopes requires auditing them against real controller structures. This skill checks these API contracts during a dry-run to ensure your OpenAPI artifacts are accurate and reusable.

When should I not use this OpenAPI generator for my PHP project?

You should not use this OpenAPI generator for project-level code quality reviews or architecture analysis. It specifically targets interface-level evidence chains and documentation modeling for Weiran Framework route-driven APIs.