PSSwagger

0.1.0

PowerShell module with commands for generating the PowerShell Cmdlets using Swagger based specifications.

Minimum PowerShell version

5.1

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PSSwagger -RequiredVersion 0.1.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name PSSwagger -Version 0.1.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) Microsoft Corporation. All rights reserved.

Package Details

Author(s)

  • Microsoft Corporation

Tags

Azure Swagger

Functions

New-PSSwaggerModule New-PSSwaggerMetadataFile

PSEditions

Desktop

Dependencies

Release Notes

First preview release of PSSwagger and PSSwaggerUtility modules. While the goal is to support all web APIs, scenarios are focused on Microsoft Azure for this first release.
## Supported Scenarios
* From an Open API v2 specification, generate a PowerShell module using [Azure AutoRest](https://github.com/azure/autorest)
   * Generating modules is only supported on PowerShell 5.1
* Customize the generation process with Open API v2 extensions in either the same specification as your web API or a separate file
   * Rename automatically generated cmdlets
* Flatten complex parameters without flattening the underlying .NET API
* Generated modules support PowerShell on Windows (PowerShell 4 or greater) or PowerShell Core on Windows, Linux or Mac
* Compile the underlying .NET API before you publish your module or compile it on-the-fly on your end-user's machine
* Debugging symbols for underlying .NET API available
* Currently supported authentication schemes:
* Basic authentication, with or without challenge
* API key based authentication
* No authentication
* Authentication using AzureRM.Profile
## Installation
Open PowerShell and run:
```powershell
Install-Package PSSwagger
```
Or visit our PowerShellGallery.com page: [link here]
## Known Issues

FileList

Version History

Version Downloads Last updated
0.3.0 8 10/10/2017
0.2.0 10 8/8/2017
0.1.0 (current version) 5 8/4/2017