salvo-openapi

Generate OpenAPI 3.0 documentation from Salvo handlers with Swagger UI integration.

1|Updated Mar 16, 2024
One-click install
npx skills add https://github.com/tdcare/genies --skill salvo-openapi-tdcare
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: salvo-openapi
Source: https://github.com/tdcare/genies/tree/main/.qoder/skills/salvo-openapi
Command: npx skills add https://github.com/tdcare/genies --skill salvo-openapi-tdcare

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

OpenAPI documentation for Salvo-based apps is generated automatically from your handlers, keeping docs in sync with code.

Core Features & Use Cases

  • Auto-generate OpenAPI 3.0 specifications from Salvo routes and endpoints.
  • Integrate with Swagger UI for interactive API exploration.
  • Enable API client generation and consistent documentation across teams.

Quick Start

Annotate Salvo handlers to enable OpenAPI generation and expose docs at /api-doc/openapi.json

Frequently Asked Questions about salvo-openapi

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

FAQPage Schema
How do I auto-generate OpenAPI documentation from Salvo handlers in Rust?

You can auto-generate OpenAPI documentation from Salvo handlers by analyzing Salvo routes, extracting endpoint metadata, and compiling it into an OpenAPI 3.0 document. This keeps your API docs in sync with your Rust code automatically.

Can I integrate Swagger UI with my Salvo API routes?

Yes, you can integrate Swagger UI with your Salvo API routes for interactive API exploration. The generated OpenAPI document includes Swagger UI integration, allowing you to expose and test docs at a specified endpoint like /api-doc/openapi.json.

What dependencies do I need to produce OpenAPI 3.0 specs for a Salvo app?

To produce OpenAPI 3.0 specs, you need the salvo-openapi dependencies and a basic Salvo router setup. These prerequisites allow the tool to analyze your routes and extract endpoint metadata for the documentation.

How do I serve API docs from my Salvo application?

You serve API docs from a Salvo application by annotating your Salvo handlers to enable OpenAPI generation. This compiles endpoint metadata into an OpenAPI document, exposing the specs at a route like /api-doc/openapi.json.

Does generating OpenAPI specs from Salvo handlers require manual route inspection?

No, generating OpenAPI specs from Salvo handlers does not require manual route inspection. The process automatically analyzes Salvo routes and extracts endpoint metadata to compile the OpenAPI 3.0 specification.

Why use auto-generated OpenAPI docs for Salvo instead of writing them manually?

Auto-generated OpenAPI docs for Salvo ensure your documentation stays in sync with your code. By extracting endpoint metadata directly from handlers, it prevents manual errors and enables consistent documentation across teams and API client generation.