skills.rest
hoangnh2412
hoangnh2412COMMUNITY
Explore all skills by this author →
WebsiteGitHub

swashbuckle-dotnet-api-key-security

Configure Swagger UI API Key security schemes for Jarvis ASP.NET Core APIs.

12|2|Updated May 4, 2020
Search Tags:#authentication#swagger#asp.net-core#api-key#jarvis#api-configuration#swashbuckle
One-click install
npx skills add https://github.com/hoangnh2412/jarvis --skill swashbuckle-dotnet-api-key-security
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: swashbuckle-dotnet-api-key-security
Source: https://github.com/hoangnh2412/jarvis/tree/main/.opencode/skills/swashbuckle-dotnet/providers/api-key-security
Command: npx skills add https://github.com/hoangnh2412/jarvis --skill swashbuckle-dotnet-api-key-security

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Jarvis.Swashbuckle, Jarvis.Authentications.ApiKey.

What problem does it solve?

This Skill eliminates the manual effort of configuring API Key security schemes in Swagger UI for Jarvis backend APIs that use X-API-KEY header authentication, ensuring Swagger correctly displays and validates API Key auth without custom, error-prone setup.

Core Features & Use Cases

  • Swagger Security Scheme Setup: Automatically configures Swagger to recognize API Key authentication via the X-API-KEY header.
  • Jarvis Auth Module Integration: Syncs Swagger security settings with the Jarvis.Authentications.ApiKey module for consistent authentication behavior across the application and Swagger UI.
  • Use Case: For a Jarvis backend API that uses API Key auth for third-party partner access, this Skill lets you quickly enable API Key testing in Swagger so partners can validate their requests directly in the interface without extra tooling.

Quick Start

Use this skill to configure Swagger API Key security for your Jarvis API that authenticates via the X-API-KEY header.

Frequently Asked Questions about swashbuckle-dotnet-api-key-security

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

FAQPage Schema
How do I configure Swagger API Key authentication for ASP.NET Core APIs?▼

Configure Swagger API Key authentication by setting up a security scheme that recognizes the X-API-KEY header, allowing Swagger UI to validate requests. This Skill automates that setup for Jarvis ASP.NET Core APIs using the Jarvis.Authentications.ApiKey module.

Why does my Swagger UI not show the API Key auth option for my Jarvis backend API?▼

Swagger UI lacks the API Key auth option when security schemes are not aligned with the application's authentication module. This Skill syncs Swagger security settings with Jarvis.Authentications.ApiKey to display and validate the X-API-KEY header directly in the interface.

Can I test API Key authentication directly in Swagger UI without extra tooling?▼

Yes, you can test API Key authentication directly in Swagger UI without extra tooling. By configuring the X-API-KEY header security scheme, this Skill enables partners to validate their requests seamlessly within the Swagger interface.

Do I need the Jarvis.Authentications.ApiKey module to use this Swagger security configuration?▼

Yes, the Jarvis.Authentications.ApiKey module is required. This Skill specifically syncs Swagger security settings with the Jarvis.Authentications.ApiKey module to ensure consistent API Key authentication behavior across the application and Swagger UI.

What is the best way to align Swagger security settings with application API Key configuration?▼

The best way to align Swagger security settings with API Key configuration is to automate the security scheme setup for the X-API-KEY header. This Skill eliminates manual, error-prone setup by integrating Swashbuckle with Jarvis authentication modules.

Are there limitations when using Swashbuckle to configure API Key security for Jarvis APIs?▼

Limitations apply strictly to Jarvis ASP.NET Core APIs using the Jarvis.Authentications.ApiKey module for X-API-KEY header authentication. This Skill targets development workflows for these specific APIs and does not support alternative authentication methods.

Related Skills

Explore More Software Engineering Skills→
hoangnh2412hoangnh2412
12

authentication-dotnet

Configure JWT Bearer, API Key, and AWS Cognito authentication for ASP.NET Core Jarvis applications.

Community
Intermediate
NmBoydNmBoyd

route-tester

Automate testing of protected API routes with cookie-based JWT authentication.

Community
Advanced
giuseppe-trisciuogliogiuseppe-trisciuoglio
322

spring-boot-openapi-documentation

Generate OpenAPI 3.0 documentation and Swagger UI for Spring Boot 3.x applications.

Community
Advanced
hoangnh2412hoangnh2412
12

swashbuckle-dotnet

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

Community
Intermediate