https://github.com/ctyar/swaggerui.openapi
A package to simplify adding Swagger UI to .NET 9's Microsoft.AspNetCore.OpenApi
https://github.com/ctyar/swaggerui.openapi
Last synced: 3 months ago
JSON representation
A package to simplify adding Swagger UI to .NET 9's Microsoft.AspNetCore.OpenApi
- Host: GitHub
- URL: https://github.com/ctyar/swaggerui.openapi
- Owner: ctyar
- License: mit
- Created: 2024-05-12T10:01:58.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-07T07:32:17.000Z (3 months ago)
- Last Synced: 2025-04-07T08:29:37.560Z (3 months ago)
- Language: C#
- Homepage:
- Size: 187 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SwaggerUI.OpenApi
[](https://ctyar.visualstudio.com/SwaggerUI.OpenApi/_build/latest?definitionId=13&branchName=main)
[](https://www.nuget.org/packages/SwaggerUI.OpenApi/)
A package to simplify adding Swagger UI to .NET 9's Microsoft.AspNetCore.OpenApi.
## Usage
1. In your `Program.cs` file Add `app.AddSwaggerUI()` and `app.MapSwaggerUI()`:
```diff
builder.Services.AddOpenApi();
+ builder.Services.AddSwaggerUI();
var app = builder.Build();
app.MapOpenApi();
+ app.MapSwaggerUI();
```
2. (Optional) Modify your `launchSettings.json` file to open Swagger automatically:
```diff
- "launchBrowser": false,
+ "launchBrowser": true,
"applicationUrl": "http://localhost:5150",
+ "launchUrl": "swagger",
```
## Features
### Authentication
If you want to add authentication to your Swagger you can use the following helper methods:
```csharp
builder.Services.AddOpenApi("v1", o =>
{
o.AddOAuth2(authorizationUrl, tokenUrl, scopes);
});
builder.Services.AddSwaggerUI("v1", o =>
{
o.AddOAuth2(clientId, scopes);
});
```
There are other helper methods for Duende Identity Server `AddIdentityServer()` and Auth0 `AddAuth0`.
You can check the [samples](/src/samples) directory for complete working examples.
### More snippet
Adds PowerShell and CMD cURL to the request snippet by default
### Styles
Easily change syntax highlighting style
```csharp
builder.Services.AddSwaggerUI(o =>
{
o.SyntaxHighlight = new SyntaxHighlightOptions
{
Theme = SyntaxHighlightThemeType.Arta
};
});
```
### Parameter validation
Displays the common validations in the parameters form by default
```csharp
app.MapGet("/products",
([Range(0, 10000)] int id,
[MinLength(3)][MaxLength(50)] string name,
[RegularExpression("\\d\\d-\\d\\d")] string code) => id)
```
### Authorization persistence
Persists authorization data by default and it would not be lost on browser close or refresh so you don't have to authenticate everytime.
## Roadmap
✅ Basic UI
✅ Authentication
✅ Enable all the documents
✅ Implement all Swagger UI options
⏳ Improve test coverage
## Acknowledgement
This project is based on [Swashbuckle.AspNetCore.SwaggerUI](https://github.com/domaindrivendev/Swashbuckle.AspNetCore). Thanks for their awesome work.
## Pre-release builds
Get the package from [here](https://github.com/ctyar/SwaggerUI.OpenApi/pkgs/nuget/SwaggerUI.OpenApi).
## Build
[Install](https://get.dot.net) the [required](global.json) .NET SDK and run:
```
$ dotnet build
```