skills.rest
boparaiamrit
boparaiamritCOMMUNITY
Explore all skills by this author →
GitHub

api-docs-skill

Generate OpenAPI specs and TypeScript SDKs from NestJS decorators.

Updated Mar 13, 2026
Search Tags:#documentation#api#openapi#sdk#swagger#nestjs
One-click install
npx skills add https://github.com/boparaiamrit/build-second-brain --skill api-docs-skill
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-docs-skill
Source: https://github.com/boparaiamrit/build-second-brain/tree/main/plugins/build-second-brain/skills/api-docs-skill
Command: npx skills add https://github.com/boparaiamrit/build-second-brain --skill api-docs-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation, OpenAPI generation, and SDK production for multi-tenant NestJS APIs is often inconsistent and hard to scale.

Core Features & Use Cases

  • Decorator-driven OpenAPI generation from NestJS controllers and DTOs to keep the codebase as the single source of truth.
  • Multi-tenant aware documentation including tenant headers and scope-based access, plus versioned changelogs.
  • TypeScript SDK generation from the OpenAPI specification to accelerate frontend integration and maintain consistency.

Quick Start

Create a NestJS application configured with this skill to automatically generate OpenAPI docs and a TypeScript SDK from your decorators.

Frequently Asked Questions about api-docs-skill

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

FAQPage Schema
How do I generate OpenAPI documentation from NestJS controllers and DTOs?▼

You can generate OpenAPI documentation directly from NestJS controllers and DTOs by using decorator-driven metadata. This approach keeps your codebase as the single source of truth for your API surface, ensuring docs stay synchronized with endpoint implementations.

How do I create a TypeScript SDK from an OpenAPI specification for frontend teams?▼

Creating a TypeScript SDK from an OpenAPI specification automates frontend integration by delivering typed clients. This ensures consistency between your backend API contracts and frontend consumption, accelerating development by providing auto-generated types.

What is the best way to document multi-tenant APIs with tenant headers and scope-based access?▼

Documenting multi-tenant APIs requires capturing tenant headers and scope-based access rules within your OpenAPI spec. This skill automates multi-tenant aware documentation, including tenant headers and scope-based access, ensuring frontend teams understand tenant boundaries and versioned changelogs.

Does this approach work with decorator-driven Swagger metadata in NestJS?▼

Yes, the approach works directly with decorator-driven Swagger metadata in NestJS. It satisfies the existing Swagger decorators configured on your controllers and DTOs, automatically extracting that metadata to produce the OpenAPI specification and TypeScript SDKs.

Can I maintain versioned changelogs and API versioning for multi-tenant NestJS APIs?▼

Yes, you can maintain versioned changelogs and API versioning for multi-tenant NestJS APIs. The skill applies to documenting endpoints and maintaining changelogs, satisfying multi-tenant header contracts while keeping a single source of truth for API surface evolution.

Related Skills

Explore More Software Engineering Skills→
genesis-agentsgenesis-agents
2

API Developer

Design and implement RESTful APIs with NestJS controllers, services, and DTOs.

Community
Intermediate
markacianfranimarkacianfrani
6

sdk-boundary

Enforces frontend-backend separation by auditing TypeScript projects for raw HTTP calls and requiring OpenAPI-generated SDKs.

Community
Advanced
edfentonedfenton
3

nean-api-docs

Generate and serve OpenAPI documentation from @nestjs/swagger decorators.

Community
Intermediate
daithang-organizationdaithang-organization

API Documentation

Generate Swagger/OpenAPI documentation for NestJS APIs with DTO coverage.

Official
Intermediate