OpenAPI 3.1 Specification Generation Skill (openapi-spec-generation)

The openapi-spec-generation skill provides tools for drafting, validating, and maintaining OpenAPI 3.1+ specifications for API contracts, static endpoints, and interactive documentation.

Operational Directives

1. Contract First & Schema Integrity:

   • Ensure explicit definitions for paths, components/schemas, responses, requestBodies, and securitySchemes.
   • Never invent response fields; inspect route code, TypeScript types, or test suites to confirm actual return types.

2. OpenAPI 3.1 Features:

   • Enforce full JSON Schema draft 2020-12 compatibility for data types.
   • Include realistic request and response examples for every HTTP status code (e.g. 200 OK, 400 Bad Request, 404 Not Found).

3. Documentation Integration:

   • Synthesize OpenAPI definitions into Markdown reference guides or Astro static endpoints (/sitemap.xml, API endpoints).

FAQs

Which OpenAPI specification versions are supported?

This skill focuses specifically on OpenAPI 3.1.0 and above.

Can this skill be used for design-first API drafting?

Yes, it supports both design-first drafting and code-first spec extraction.

Deep State of Mind (DSOM) For My AI Protocol | Harisfazillah Jamel (LinuxMalaysia) | 2026-09-06
Standard: UK English | DBP-standard Bahasa Melayu Malaysia (Piawai) | GNU General Public License v3.0