skills.rest
FaysilAlshareef
FaysilAlshareefCOMMUNITY
Explore all skills by this author →
GitHub

scalar-docs

Configure gateway API endpoints with Scalar to centralize OpenAPI documentation and UI.

4|1|Updated Mar 15, 2026
Search Tags:#ui#documentation#security#openapi#api-docs#gateway
One-click install
npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill scalar-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: scalar-docs
Source: https://github.com/FaysilAlshareef/dotnet-ai-kit/tree/main/skills/microservice/gateway/scalar-docs
Command: npx skills add https://github.com/FaysilAlshareef/dotnet-ai-kit --skill scalar-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Scalar docs provide a centralized solution to configure and publish gateway API documentation with OpenAPI entries, a dedicated UI, and security scaffolding, reducing the effort required to keep docs in sync with gateway endpoints.

Core Features & Use Cases

  • Centralized OpenAPI doc entries per gateway with environment-aware visibility.
  • Scalar UI at the /scalar endpoint for interactive API documentation and version selection.
  • Extensions to register doc entries, apply security transformers, and enable rate-limiting integrations (Pentagon).
  • Quick-start scenarios include wiring AddOpenApiDocumentation and UseOpenApiDocumentation in startup for gateways.

Quick Start

Configure Scalar documentation for your gateway project by calling AddOpenApiDocumentation and UseOpenApiDocumentation in your startup, then run your app and visit /scalar for the UI.

Frequently Asked Questions about scalar-docs

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

FAQPage Schema
How do I document gateway API endpoints with OpenAPI using Scalar?▼

Document gateway API endpoints with Scalar by calling AddOpenApiDocumentation and UseOpenApiDocumentation in your startup, then visiting the /scalar endpoint to view the interactive UI. This centralizes OpenAPI entries with environment-aware visibility.

Can I configure per-version API documentation for a microservice gateway?▼

Yes, you can configure per-version API documentation for a microservice gateway by registering centralized OpenAPI doc entries. This enables environment-based visibility and dedicated version selection within the Scalar UI.

How do I secure OpenAPI documentation in production with Scalar?▼

Secure OpenAPI documentation in production by applying security transformers and basic protections for production access. The extensions enable you to register doc entries, apply security schemes, and integrate rate-limiting.

What is the best way to centralize API docs across multiple gateway environments?▼

Centralize API docs across gateway environments by configuring environment-aware OpenAPI entries with Scalar. This approach provides a dedicated UI at the /scalar endpoint, keeping documentation synchronized with gateway endpoints.

Does Scalar documentation support rate-limiting integrations for API gateways?▼

Yes, Scalar documentation supports rate-limiting integrations through extensions like Pentagon. You can apply security transformers and enable rate-limiting alongside registering OpenAPI doc entries for your gateway project.

How do I customize the Scalar UI theme for my OpenAPI documentation?▼

Customize the Scalar UI theme for OpenAPI documentation by implementing the available UI theming extensions. This allows you to style the dedicated /scalar endpoint interface for interactive API documentation and version selection.

Related Skills

Explore More Software Engineering Skills→
FaysilAlshareefFaysilAlshareef
4

openapi-scalar

Generate OpenAPI specifications and Scalar UI documentation for .NET 9+ applications.

Community
Intermediate
RaheesAhmedRaheesAhmed
66

api-architect

Design REST and GraphQL APIs with authentication, versioning, and OpenAPI documentation.

Community
Advanced
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
teexiiiteexiii

swagger

Serve interactive Swagger UI and raw OpenAPI spec from a TypeScript-based definition.

Community
Intermediate