swashbuckle-dotnet

Configure multi-version Swagger/OpenAPI with JWT and API Key security for ASP.NET Core Jarvis projects.

12|2|Updated May 4, 2020
One-click install
npx skills add https://github.com/hoangnh2412/jarvis --skill swashbuckle-dotnet
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: swashbuckle-dotnet
Source: https://github.com/hoangnh2412/jarvis/tree/main/.opencode/skills/swashbuckle-dotnet
Command: npx skills add https://github.com/hoangnh2412/jarvis --skill swashbuckle-dotnet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually configuring Swagger/OpenAPI for Jarvis .NET backends with multi-version support, standardized BaseResponse schemas, and security schemes (JWT, API Key) is time-consuming and prone to misconfiguration, especially when adhering to Jarvis' clean architecture and layer extension patterns.

Core Features & Use Cases

  • End-to-end Swagger orchestration: Automates setup of Jarvis.Swashbuckle for multi-version Swagger UI with standardized BaseResponse schema support, aligned with Jarvis' clean architecture layer patterns.
  • Modular workflow support: Provides step-by-step workflows for initial Swagger integration into new Jarvis Host projects and for adding new API versions or security schemes to existing setups.
  • Atomic security providers: Includes dedicated sub-skills for configuring JWT Bearer and API Key security schemes in Swagger, with links to corresponding Jarvis authentication configurations.
  • Use Case: A developer building a Jarvis .NET 9 e-commerce API can use this skill to enable Swagger with v1 and v2 support, add JWT authentication to the Swagger UI authorize button, and ensure all API responses use the standard BaseResponse schema, all in minutes instead of hours of manual configuration.

Quick Start

Use the swashbuckle-dotnet skill to configure multi-version Swagger with JWT security for your existing Jarvis .NET Host project.

Frequently Asked Questions about swashbuckle-dotnet

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

FAQPage Schema
How do I configure multi-version Swagger for ASP.NET Core APIs?

Multi-version Swagger for ASP.NET Core APIs is configured by automating OpenAPI setup with standardized BaseResponse schema support, aligned with Jarvis clean architecture layer extension dependency injection patterns to ensure proper API versioning documentation.

How do I add JWT authentication to the Swagger UI Authorize button in .NET?

Adding JWT authentication to the Swagger UI Authorize button in .NET requires configuring a JWT Bearer security scheme within your Swashbuckle setup, linking it to the corresponding Jarvis authentication module to enable secure token-based authorization testing directly from the interface.

Can I use API Key security schemes with Swagger in a .NET backend?

Yes, you can configure API Key security schemes with Swagger in a .NET backend by applying dedicated atomic security providers that integrate seamlessly with Jarvis authentication modules, allowing API key authorization directly within the Swagger UI.

Does Jarvis clean architecture support standardized BaseResponse schemas in OpenAPI documentation?

Yes, Jarvis clean architecture supports standardized BaseResponse schemas in OpenAPI documentation by enforcing consistent response formatting across all exposed endpoints, ensuring the generated Swagger UI accurately reflects the standard wrapper for all API responses.

What is the best way to add a new API version to an existing Swagger setup?

The best way to add a new API version to an existing Swagger setup is through modular workflow support that provides step-by-step configuration for new versions, ensuring the new endpoints integrate cleanly with existing OpenAPI documentation and dependency injection.