nuget updates
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
## About
|
||||
|
||||
Microsoft.AspNetCore.OpenApi is a NuGet package that provides built-in support for generating OpenAPI documents from minimal or controller-based APIs in ASP.NET Core.
|
||||
|
||||
## Key Features
|
||||
|
||||
* Supports viewing generated OpenAPI documents at runtime via a parameterized endpoint (`/openapi/{documentName}.json`)
|
||||
* Supports generating an OpenAPI document at build-time
|
||||
* Supports customizing the generated document via document transformers
|
||||
|
||||
## How to Use
|
||||
|
||||
To start using Microsoft.AspNetCore.OpenApi in your ASP.NET Core application, follow these steps:
|
||||
|
||||
### Installation
|
||||
|
||||
```sh
|
||||
dotnet add package Microsoft.AspNetCore.OpenApi
|
||||
```
|
||||
|
||||
### Configuration
|
||||
|
||||
In your Program.cs file, register the services provided by this package in the DI container and map the provided OpenAPI document endpoint in the application.
|
||||
|
||||
```C#
|
||||
var builder = WebApplication.CreateBuilder();
|
||||
|
||||
// Registers the required services
|
||||
builder.Services.AddOpenApi();
|
||||
|
||||
var app = builder.Build();
|
||||
|
||||
// Adds the /openapi/{documentName}.json endpoint to the application
|
||||
app.MapOpenApi();
|
||||
|
||||
app.Run();
|
||||
```
|
||||
|
||||
For more information on configuring and using Microsoft.AspNetCore.OpenApi, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/fundamentals/minimal-apis/openapi).
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `OpenApiOptions`: Options for configuring OpenAPI document generation.
|
||||
* `IDocumentTransformer`: Transformer that modifies the OpenAPI document generated by the library.
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.AspNetCore.OpenApi is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).
|
||||
Reference in New Issue
Block a user