skills.rest
lucidash
lucidashCOMMUNITY
Explore all skills by this author →
GitHub

swagger-link

Generate Swagger UI links from API controllers or HTTP inputs.

5|7|Updated Jul 21, 2014
Search Tags:#typescript#documentation#api#swagger#link-generation#rapi-doc
One-click install
npx skills add https://github.com/lucidash/dotfiles --skill swagger-link
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: swagger-link
Source: https://github.com/lucidash/dotfiles/tree/main/claude/skills/swagger-link
Command: npx skills add https://github.com/lucidash/dotfiles --skill swagger-link

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Swagger link generation automates the creation of direct Swagger UI URLs from API controllers or explicit HTTP endpoints, saving frontend teams time when wiring FE to backend docs.

Core Features & Use Cases

  • Direct Link from Controller: derive a Swagger URL from a TypeScript controller file and method.
  • Direct Mode: supply HTTP method and path to instantly produce a link.
  • FE Integration & Guides: generate a ready-to-share FE integration guide with the --guide flag.
  • Spec Auto-detection: automatically determine the API spec (likey-api, likey-admin-api, likey-tasks) and host based on stage.

Quick Start

Use the swagger-link tool to generate a direct link for a specific API, for example: swagger-link src/api/coupon-controller.ts:fetchMyCouponsV2 --preview=my-coupons-api

Or generate a FE guide for multiple changes: swagger-link --guide --preview=my-coupons-api

Frequently Asked Questions about swagger-link

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

FAQPage Schema
How do I generate a direct Swagger UI link from a TypeScript API controller?▼

Generate a direct Swagger UI link from a TypeScript API controller by pointing the tool at the controller file and method. It analyzes controller decorators to derive base paths and builds a shareable RapiDoc-compatible URL.

Can I create a Swagger link by providing just an HTTP method and path?▼

Yes, you can create a Swagger link using explicit HTTP methods and paths through direct mode. Supplying the raw HTTP specification instantly produces a URL without needing a controller file.

How does Swagger link auto-detection work for different API specs?▼

Swagger link auto-detection works by automatically selecting the correct API spec from likey-api, likey-admin-api, or likey-tasks. It then builds the URL with the appropriate stage-based host for the environment.

How do I generate a frontend integration guide for API documentation?▼

Generate a frontend integration guide for API documentation by using the guided FE documentation mode. Running the tool with the guide flag produces a ready-to-share guide for wiring frontend changes to backend docs.

Can I preview a specific API environment when generating a Swagger link?▼

Yes, you can preview a specific API environment when generating a Swagger link. Use the preview flag with a custom preview name to build RapiDoc-compatible URLs pointing to that specific environment.

Does Swagger link generation work without external dependencies?▼

Yes, Swagger link generation works without external dependencies. The tool independently parses TypeScript controller decorators and raw HTTP inputs to construct RapiDoc-compatible URLs with stage-based hosts.

Related Skills

Explore More Software Engineering Skills→
Ahoo-WangAhoo-Wang
15

fetcher-decorator-service

Define HTTP API services declaratively with TypeScript decorators.

Community
Intermediate
pradyumnasagarpradyumnasagar
6

roadmap-author

Guide authors through creating and validating ORS SKILL.md files.

Community
Intermediate
traylinxtraylinx
2

api-designer

Design REST APIs and OpenAPI specifications with endpoint naming and schema validation.

Official
Advanced
edfentonedfenton
3

nean-api-docs

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

Community
Intermediate