The AutoRest tool generates client libraries for accessing RESTful web services. Input to AutoRest is a spec that describes the REST API using the Open API Initiative format.
AutoRest has been thru a lot of changes recently, most notably:
- we've switched to building the core components with the latest dotnet-cli tools, and the binaries are build for .NET Core 1.0 (aka 'CoreCLR')
- we're starting to build some of the components in NodeJS - this allows us to leverage all sorts of other great functionality with less coding effort
- we have a great cross-platform installation model for Windows, Mac OSX and Linux, which is built on top of NodeJS's
npmpackage manager
Previously, in order to get AutoRest, you had to either get an older version from Chocolatey, or install a 'nightly' build from the MyGet feed using the NuGet tool. This didn't make it easier to keep up-to-date with AutoRest (as development happens pretty fast these days!), and often bugs were getting fixed and it was a pain for users to get the updated binaries.
Now, you can "install" AutoRest just once, and AutoRest itself has the ability to download and install any updates, as well as allowing the user to choose any arbitrary build at runtime, and it will use the requested verion.
This will let you install a 'release' version of AutoRest, and use that, but if you want to test a new nightly or preview version, you can just ask for it on the command line.
Additionally, we're making AutoRest work in multiple environments, (including a upcoming Visual Studio Code extension), and using this model, AutoRest will give exactly the same results from the command line as in the IDE, without having to manually fight to switch versions when you want.
Installing AutoRest on Windows, MacOS or Linux involves two steps:
- Install Node.js (6.9.5 or greater)
for more help, check out Installing Node.JS on different platforms
- Install AutoRest using
npm
# Depending on your configuration you may need to be elevated or root to run this. (on OSX/Linux use 'sudo' )
npm install -g autorestTo update AutoRest if you have previous versions installed, please run:
autorest --latestor
# Removes all other versions and installs the latest
autorest --resetFor more information, run autorest --help
| OS | Status |
|---|---|
| Windows x64 | Verified - Working |
| OSX 10.11 x64 | Verified - Working (may have to install openssl manually?) |
| Ubuntu 14.04 x64 (any) | Verified - Working -- use the following commands first: sudo apt-get update && sudo apt-get upgrade -y && sudo apt-get install libunwind8 libicu52 -y |
| Ubuntu 16.04 x64 (desktop) | Verified - Working |
| Ubuntu 16.04 x64 (server or via BashForWindows/WSL) | Verified - Working -- use the following commands first: sudo apt-get update && sudo apt-get upgrade -y && sudo apt-get install libunwind8 -y |
| Ubuntu 16.10 x64 | Verified - Working -- use the following commands first: sudo apt-get update && sudo apt-get upgrade -y && sudo apt-get install libunwind8 -y && wget http://mirrors.kernel.org/ubuntu/pool/main/i/icu/libicu55_55.1-7_amd64.deb && sudo dpkg -i libicu55_55.1-7_amd64.deb |
Other Linux platforms might work -- if the platform is listed https://github.com/Azure/autorest/releases/tag/dotnet-runtime-1.0.4 -- there is a fairly good chance that it'll work. As more testing is completed, we'll ensure that we update the status here.
You can test out the PREVIEW AutoRest installer from : https://github.com/Azure/autorest/releases/download/dotnet-runtime-1.0.3/AutoInstaller.exe
Note: The Installer is a work-in-progress -- it has been tested for the happy path, some functionality isn't yet implemented:
- Remove/Uninstall - not yet implemented
- Upgrade - minimally tested
- About and Project buttons - not yet implemented
- not yet codesiged
- no silent/unattended mode yet
- Feedback welcome at Azure#1884
Start by reading the documentation for using AutoRest:
- Managing Autorest - shows how to get new updates to AutoRest and choose which version to use for code generation
- Generating a Client using AutoRest - shows simple command line usage for generating a client library.
- Command Line Interface Documentation - explains common command line arguments
- Examples - full, walkthrough-style scenarios for using AutoRest
Get yourself up and coding in AutoRest
- Developer Workstation Requirements - what do you need to install to start working with the AutoRest code
- Compiling AutoRest - compiling/testing AutoRest using the build scripts
Some information about the internal AutoRest architecture (may need updating!):
- Developer Guide - Notes on developing with AutoRest
- AutoRest and ClientRuntimes - about the client runtime requirements for AutoRest
- The
CodeModeldata model and the Language-specific Generator/Transformer/Namer Fixable<T>implementation - When a value is both calculated and/or fixed- LODIS - The Least Offensive Dependency Injection System
- Name Disambiguation - how names don't collide in code generation.
- Validation Rules & Linting - about the validation rules in AutoRest
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.