Repository navigation
Enable Swagger/Scalar Documentation - #982
Merged
Merged
Conversation
padfoot044
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR enables Swagger UI and Scalar API Reference to be available in all environments, not just Development. The OpenAPI documentation endpoints are moved out of the environment-specific conditional block, making API documentation accessible regardless of the hosting environment.
Key Changes:
- Added OpenAPI document metadata (title, version, description) to improve API documentation
- Removed environment-based conditional that restricted Swagger UI to Development only
- Configured explicit paths for Swagger UI (
/swagger) and OpenAPI spec (/openapi/{documentName}.json)
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Clean.Architecture.Web/Program.cs | Added document settings configuration for OpenAPI specification including title, version, and description |
| src/Clean.Architecture.Web/Configurations/MiddlewareConfig.cs | Removed Development environment check for Swagger/Scalar UIs and added explicit path configurations for both documentation tools |
padfoot044
changed the title
Contributor
Author
|
@ardalis , please review |
ardalis
approved these changes
Dec 1, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.