| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Adds a new OpenAPI map route to the Kestrun server. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This function allows you to add a new OpenAPI map route to the Kestrun server by specifying the route path, Open |
| | | 6 | | .PARAMETER Server |
| | | 7 | | The Kestrun server instance to which the route will be added. |
| | | 8 | | If not specified, the function will attempt to resolve the current server context. |
| | | 9 | | .PARAMETER Options |
| | | 10 | | The MapRouteOptions object to configure the route. |
| | | 11 | | .PARAMETER Pattern |
| | | 12 | | The URL path for the new OpenAPI map route. |
| | | 13 | | Default is '/openapi/{version}/openapi.{format}'. |
| | | 14 | | .PARAMETER DocId |
| | | 15 | | The OpenAPI document ID to be served by this route. |
| | | 16 | | .PARAMETER SpecVersion |
| | | 17 | | An array of OpenAPI specification versions to support (e.g., OpenApi2_0 or OpenApi3_0). |
| | | 18 | | .PARAMETER VersionVarName |
| | | 19 | | The name of the route variable used to specify the OpenAPI version. |
| | | 20 | | .PARAMETER FormatVarName |
| | | 21 | | The name of the route variable used to specify the OpenAPI format (e.g., json or yaml). |
| | | 22 | | .PARAMETER RefreshVarName |
| | | 23 | | The name of the route variable used to trigger a refresh of the OpenAPI document. |
| | | 24 | | .PARAMETER DefaultFormat |
| | | 25 | | The default format for the OpenAPI document if not specified in the route. |
| | | 26 | | .PARAMETER DefaultVersion |
| | | 27 | | The default version for the OpenAPI document if not specified in the route. |
| | | 28 | | .PARAMETER PassThru |
| | | 29 | | If specified, the function will return the created route object. |
| | | 30 | | .OUTPUTS |
| | | 31 | | [Kestrun.Hosting.KestrunHost] representing the created route. |
| | | 32 | | .EXAMPLE |
| | | 33 | | Add-KrOpenApiRoute -Server $myServer -Pattern "/openapi/{version}/{format}" -SpecVersion @('OpenApi3_0') ` |
| | | 34 | | -VersionVarName "version" -FormatVarName "format" -DefaultFormat "json" -DefaultVersion "v3.0" |
| | | 35 | | Adds a new OpenAPI map route to the specified Kestrun server with the given pattern and options. |
| | | 36 | | .EXAMPLE |
| | | 37 | | Get-KrServer | Add-KrOpenApiRoute -Pattern "/openapi/{version}/{format}" -SpecVersion @('OpenApi3_0') ` |
| | | 38 | | -VersionVarName "version" -FormatVarName "format" -DefaultFormat "json" -DefaultVersion "v3.0" -PassThru |
| | | 39 | | Adds a new OpenAPI map route to the specified Kestrun server with the given pattern and options. |
| | | 40 | | .NOTES |
| | | 41 | | This function is part of the Kestrun PowerShell module and is used to manage routes |
| | | 42 | | #> |
| | | 43 | | function Add-KrOpenApiRoute { |
| | | 44 | | [KestrunRuntimeApi('Definition')] |
| | | 45 | | [CmdletBinding()] |
| | | 46 | | [OutputType([Kestrun.Hosting.KestrunHost])] |
| | | 47 | | param( |
| | | 48 | | [Parameter(Mandatory = $false, ValueFromPipeline = $true)] |
| | | 49 | | [Kestrun.Hosting.KestrunHost]$Server, |
| | | 50 | | |
| | | 51 | | [Parameter()] |
| | | 52 | | [Kestrun.Hosting.Options.MapRouteOptions]$Options, |
| | | 53 | | |
| | | 54 | | [Parameter()] |
| | | 55 | | [alias('Path')] |
| | | 56 | | [string]$Pattern, |
| | | 57 | | |
| | | 58 | | [Parameter()] |
| | | 59 | | [Alias('DocumentId')] |
| | | 60 | | [string]$DocId = [Kestrun.OpenApi.OpenApiDocDescriptor]::DefaultDocumentationId, |
| | | 61 | | |
| | | 62 | | [Parameter()] |
| | | 63 | | [Microsoft.OpenApi.OpenApiSpecVersion[]]$SpecVersion, |
| | | 64 | | |
| | | 65 | | [Parameter()] |
| | | 66 | | [string]$VersionVarName, |
| | | 67 | | |
| | | 68 | | [Parameter()] |
| | | 69 | | [string]$FormatVarName, |
| | | 70 | | |
| | | 71 | | [Parameter()] |
| | | 72 | | [string]$RefreshVarName, |
| | | 73 | | |
| | | 74 | | [Parameter()] |
| | | 75 | | [string]$DefaultFormat, |
| | | 76 | | |
| | | 77 | | [Parameter()] |
| | | 78 | | [string]$DefaultVersion, |
| | | 79 | | |
| | | 80 | | [Parameter()] |
| | | 81 | | [switch]$PassThru |
| | | 82 | | ) |
| | | 83 | | begin { |
| | | 84 | | # Ensure the server instance is resolved |
| | 0 | 85 | | $Server = Resolve-KestrunServer -Server $Server |
| | | 86 | | } |
| | | 87 | | process { |
| | 0 | 88 | | if ($null -eq $Options) { |
| | 0 | 89 | | $Options = [Kestrun.Hosting.Options.MapRouteOptions]::new() |
| | | 90 | | } |
| | 0 | 91 | | if (-not [string]::IsNullOrEmpty($Pattern)) { |
| | 0 | 92 | | $Options.Pattern = $Pattern |
| | | 93 | | } |
| | 0 | 94 | | $Options.HttpVerbs = @('GET') |
| | 0 | 95 | | $OpenApiMapRouteOptions = [Kestrun.Hosting.Options.OpenApiMapRouteOptions]::new($Options) |
| | 0 | 96 | | if ($PsBoundParameters.ContainsKey('DefaultFormat')) { |
| | 0 | 97 | | $OpenApiMapRouteOptions.DefaultFormat = $DefaultFormat |
| | | 98 | | } |
| | 0 | 99 | | if ($PsBoundParameters.ContainsKey('DefaultVersion')) { |
| | 0 | 100 | | $OpenApiMapRouteOptions.DefaultVersion = $DefaultVersion |
| | | 101 | | } |
| | 0 | 102 | | if ($PsBoundParameters.ContainsKey('FormatVarName')) { |
| | 0 | 103 | | $OpenApiMapRouteOptions.FormatVarName = $FormatVarName |
| | | 104 | | } |
| | 0 | 105 | | if ($PsBoundParameters.ContainsKey('VersionVarName')) { |
| | 0 | 106 | | $OpenApiMapRouteOptions.VersionVarName = $VersionVarName |
| | | 107 | | } |
| | 0 | 108 | | if ($PsBoundParameters.ContainsKey('RefreshVarName')) { |
| | 0 | 109 | | $OpenApiMapRouteOptions.RefreshVarName = $RefreshVarName |
| | | 110 | | } |
| | 0 | 111 | | if ($PsBoundParameters.ContainsKey('SpecVersion')) { |
| | 0 | 112 | | $OpenApiMapRouteOptions.SpecVersions = $SpecVersion |
| | | 113 | | } |
| | 0 | 114 | | if ($PsBoundParameters.ContainsKey('DocId')) { |
| | 0 | 115 | | $OpenApiMapRouteOptions.DocId = $DocId |
| | | 116 | | } |
| | | 117 | | |
| | | 118 | | # Call the C# extension method to add the OpenAPI map route |
| | 0 | 119 | | [Kestrun.Hosting.KestrunHostMapExtensions]::AddOpenApiMapRoute($Server, $OpenApiMapRouteOptions) | Out-Null |
| | | 120 | | |
| | | 121 | | # Return the server if PassThru is specified |
| | 0 | 122 | | if ($PassThru) { |
| | 0 | 123 | | return $Server |
| | | 124 | | } |
| | | 125 | | } |
| | | 126 | | } |