openapi

Generate TypeScript types and client SDKs from OpenAPI 3.1 specifications.

4|Updated Jan 15, 2026
One-click install
npx skills add https://github.com/mgd34msu/goodvibes-gemini --skill openapi-mgd34msu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi
Source: https://github.com/mgd34msu/goodvibes-gemini/tree/main/skills/openapi
Command: npx skills add https://github.com/mgd34msu/goodvibes-gemini --skill openapi-mgd34msu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill streamlines API development by providing tools to define, generate code from, and validate OpenAPI specifications, ensuring consistency and reducing errors.

Core Features & Use Cases

  • API Specification: Define RESTful APIs using the OpenAPI 3.1 standard.
  • Code Generation: Generate TypeScript types, client SDKs, and server stubs.
  • Schema Validation: Validate request and response payloads against the OpenAPI schema.
  • Documentation UI: Easily serve interactive API documentation (Swagger UI, Redoc).
  • Use Case: You're building a new microservice and need to define its API contract. Use this Skill to create an openapi.yaml file, generate TypeScript types for your request/response bodies, and set up a basic Express server stub.

Quick Start

Use the openapi skill to generate TypeScript types from the './openapi.yaml' file and save them to './types/api.d.ts'.

Frequently Asked Questions about openapi

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

FAQPage Schema
How do I generate TypeScript types from an OpenAPI specification?

You can generate TypeScript types from an OpenAPI specification by applying the openapi skill to your schema file, which processes the definitions and outputs type declarations like './types/api.d.ts' for immediate use in your project.

What is the best way to implement contract-first API design for a microservice?

Contract-first API design is best implemented by defining your RESTful API using the OpenAPI 3.1 standard to create a specification file, then generating server stubs, client SDKs, and TypeScript types directly from that contract.

Can I generate both client SDKs and server stubs from an OpenAPI 3.1 schema?

Yes, you can generate both client SDKs and server stubs from an OpenAPI 3.1 schema, utilizing openapi-fetch for client generation and producing basic Express server stubs to standardize your API implementation.

How do I validate request and response payloads against an OpenAPI schema?

You validate request and response payloads against an OpenAPI schema by applying the skill's schema validation features, ensuring that your data matches the defined OpenAPI 3.1 contract to reduce errors and maintain consistency.

Does this approach support serving interactive API documentation like Swagger UI?

Yes, this approach supports serving interactive API documentation, allowing you to easily set up and host documentation interfaces like Swagger UI and Redoc directly from your generated OpenAPI specifications.

Why should I use OpenAPI 3.1 for documenting RESTful APIs?

You should use OpenAPI 3.1 for documenting RESTful APIs because it streamlines development by providing a standardized contract, enabling automated TypeScript type generation, schema validation, and interactive documentation to reduce errors.