skills.rest
VilnaCRM-Org
VilnaCRM-OrgOFFICIAL
Explore all skills by this author →
GitHub

openapi-development

Develop and validate OpenAPI generation pipelines for PHP services.

16|2|Updated May 28, 2023
Search Tags:#openapi#validation#php#symfony#api-design#spectral
One-click install
npx skills add https://github.com/VilnaCRM-Org/user-service --skill openapi-development
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openapi-development
Source: https://github.com/VilnaCRM-Org/user-service/tree/main/.claude/skills/openapi-development
Command: npx skills add https://github.com/VilnaCRM-Org/user-service --skill openapi-development

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guide teams to contribute to and maintain the OpenAPI layer across services, ensuring consistent spec generation and validation.

Core Features & Use Cases

  • Centralized OpenAPI generation and customization through Factory/Augmenter/Cleaner components.
  • Built-in validation and diff tooling (Spectral, OpenAPI diff, Schemathesis) to ensure stable specs.
  • Clear guidance for adding new endpoint factories and schema transformations while preserving immutability.

Quick Start

Install and configure the OpenAPI layer to generate and validate the API specification.

Frequently Asked Questions about openapi-development

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

FAQPage Schema
How do I generate and validate an OpenAPI spec for a PHP Symfony service?▼

You can validate your OpenAPI specification using Spectral, OpenAPI diff, and Schemathesis tools to enforce immutability, low complexity, and diff-stable outputs while catching schema validation errors.

How do I add a new endpoint factory to an existing OpenAPI generation pipeline?▼

Add new endpoint factories by integrating them into the centralized OpenAPI generation layer, ensuring you apply appropriate sanitizers and augmenters while preserving immutability and schema transformations.

Does this OpenAPI validation approach work with PHP and Symfony?▼

Yes, this OpenAPI validation and generation pipeline is specifically designed for PHP services using Symfony, providing built-in tooling to maintain consistent and stable API specifications across your services.

Why does my OpenAPI spec fail validation when adding new schema transformations?▼

OpenAPI spec validation fails when new schema transformations break immutability or increase complexity, requiring you to apply cleaners and run validation tools like Spectral to fix the generated outputs.

Related Skills

Explore More Software Engineering Skills→
dieu-donneedieu-donnee

php-pro

Scaffold Laravel or Symfony APIs with strict types and PHPStan level 9.

Community
Advanced
vladm3105vladm3105
16

contract-tester

Validate API contracts and detect breaking changes across OpenAPI/AsyncAPI specifications.

Community
Advanced
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
BNTangBNTang

swagger-annotations

Inject missing Swagger/OpenAPI annotations into Spring Boot REST controllers.

Community
Advanced