Enable PodeOAViewer - mdaneri/Pode GitHub Wiki
external help file: Pode-help.xml Module Name: Pode online version: https://github.com/mrin9/RapiPdf PodeType: OpenApi schema: 2.0.0
Adds a route that enables a viewer to display OpenAPI docs, such as Swagger, ReDoc, RapiDoc, StopLight, Explorer, RapiPdf or Bookmarks.
Enable-PodeOAViewer -Type <String> [-Path <String>] [-OpenApiUrl <String>] [-Middleware <Object[]>]
[-Title <String>] [-DarkMode] [-EndpointName <String[]>] [-Authentication <String>] [-Role <String[]>]
[-Group <String[]>] [-Scope <String[]>] [-DefinitionTag <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Enable-PodeOAViewer [-Path <String>] [-OpenApiUrl <String>] [-Middleware <Object[]>] [-Title <String>]
[-DarkMode] [-EndpointName <String[]>] [-Authentication <String>] [-Role <String[]>] [-Group <String[]>]
[-Scope <String[]>] [-Bookmarks] [-NoAdvertise] [-DefinitionTag <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Enable-PodeOAViewer [-Path <String>] [-OpenApiUrl <String>] [-Middleware <Object[]>] [-Title <String>]
[-DarkMode] [-EndpointName <String[]>] [-Authentication <String>] [-Role <String[]>] [-Group <String[]>]
[-Scope <String[]>] [-Editor] [-DefinitionTag <String>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Adds a route that enables a viewer to display OpenAPI docs, such as Swagger, ReDoc, RapiDoc, StopLight, Explorer, RapiPdf or Bookmarks.
Enable-PodeOAViewer -Type Swagger -DarkMode
Enable-PodeOAViewer -Type ReDoc -Title 'Some Title' -OpenApi 'http://some-url/openapi'
Enable-PodeOAViewer -Bookmarks
Adds a route that enables a viewer to display with links to any documentation tool associated with the OpenApi.
The name of an Authentication method which should be used as middleware on this Route.
Type: String
Parameter Sets: (All)
Aliases: Auth
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, create a new documentation bookmarks page
Type: SwitchParameter
Parameter Sets: Bookmarks
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, the page will be rendered using a dark theme (this is not supported for all viewers).
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseA string representing the unique tag for the API specification. This tag helps distinguish between different versions or types of API specifications within the application. You can use this tag to reference the specific API documentation, schema, or version that your function interacts with.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, enable the Swagger-Editor
Type: SwitchParameter
Parameter Sets: Editor
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe EndpointName of an Endpoint(s) to bind the static Route against.This parameter is normally not required. The Endpoint is retrieved by the OpenAPI DefinitionTag
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOne or more optional Groups that will be authorised to access this Route, when using Authentication with an Access method.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseLike normal Routes, an array of Middleware that will be applied.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf supplied, it is not going to state the documentation URL at the startup of the server
Type: SwitchParameter
Parameter Sets: Bookmarks
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe URL where the OpenAPI definition can be retrieved. (Default is the OpenAPI path from Enable-PodeOpenApi)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe route Path where the docs can be accessed. (Default: "/$Type")
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOne or more optional Roles that will be authorised to access this Route, when using Authentication with an Access method.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseOne or more optional Scopes that will be authorised to access this Route, when using Authentication with an Access method.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe title of the web page. (Default is the OpenAPI title from Enable-PodeOpenApi)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe Type of OpenAPI viewer to use.
Type: String
Parameter Sets: Doc
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
https://github.com/mrin9/RapiPdf
https://github.com/Authress-Engineering/openapi-explorer
https://github.com/stoplightio/elements
https://github.com/rapi-doc/RapiDoc