autorest/README.md

AutoRest

The AutoRest tool generates client libraries for accessing RESTful web services. Input to AutoRest is a spec that describes the REST API using the OpenAPI Specification format.

Support Policy

AutoRest is an open source tool -- if you need assistance, first check the documentation. If you find a bug or need some help, feel free to submit an issue

AutoRest will release a stable version on the second Wednesday of the month.

Using npm you can upgrade to the latest stable version of AutoRest:

---

Installing AutoRest

Installing AutoRest on Windows, MacOS or Linux involves two steps:

1. Install Node.js (7.10.0 or greater)

for more help, check out Installing Node.JS on different platforms

2. 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 autorest

Updating AutoRest

To update AutoRest if you have previous versions installed, please run:

autorest --latest

or

# Removes all other versions and installs the latest
autorest --reset

For more information, run autorest --help

Supported Platforms

While AutoRest itself runs on NodeJS, some generators use the .NET Core 2.0 runtime, which is the most limiting factor. See dotnet/core/release-notes/2.0/2.0-supported-os.md for a list of supported platforms.

Getting Started using AutoRest

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

Developers

Get yourself up and coding in AutoRest

• Developer Workstation Requirements - what do you need to install to start working with the AutoRest code
• AutoRest Extensibility and protocol documentation
• Working on AutoRest core - compiling/testing AutoRest core using the build scripts
• Working on an AutoRest extension - creating and testing AutoRest extensions
• AutoRest repositories and packages - all maintained repositories and packages on one page

Some related information:

• Validation Rules & Linting - about the validation rules in AutoRest
• Client Runtimes - information about the client runtimes required for using code generated by AutoRest

---

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.