OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, Go, Java, Node.js, TypeScript, Python, Ruby and PHP.
Switch branches/tags
v2.0.4216 v2.0.4215 v1.2.2 v1.2.1 v1.2.1-20170717-2300-nightly v1.2.1-20170716-2300-nightly v1.2.1-20170715-2300-nightly v1.2.0 v1.2.0-20170714-2300-nightly v1.2.0-20170713-2300-nightly v1.1.0 v1.1.0-20170712-2300-nightly v1.1.0-20170711-2300-nightly v1.1.0-20170710-2300-nightly v1.1.0-20170709-2300-nightly v1.1.0-20170708-2300-nightly v1.1.0-20170707-2300-nightly v1.1.0-20170706-2300-nightly v1.1.0-20170705-2300-nightly v1.1.0-20170704-2300-nightly v1.1.0-20170703-2300-nightly v1.1.0-20170702-2300-nightly v1.1.0-20170701-2300-nightly v1.1.0-20170630-2300-nightly v1.1.0-20170629-2300-nightly v1.1.0-20170628-2300-nightly v1.1.0-20170627-2300-nightly v1.1.0-20170626-2300-nightly v1.1.0-20170625-2300-nightly v1.1.0-20170624-2300-nightly v1.1.0-20170623-2300-nightly v1.1.0-20170622-2300-nightly v1.1.0-20170621-2300-nightly v1.1.0-20170620-2300-nightly v1.1.0-20170619-2300-nightly v1.1.0-20170619-2207-preview v1.1.0-20170618-2300-nightly v1.1.0-20170617-2300-nightly v1.1.0-20170616-2300-nightly v1.1.0-20170615-2300-nightly v1.0.1 v1.0.1-20170614-2300-nightly v1.0.1-20170613-2300-nightly v1.0.1-20170612-2300-nightly v1.0.1-20170611-2300-nightly v1.0.1-20170610-2300-nightly v1.0.1-20170609-2300-nightly v1.0.1-20170608-2300-nightly v1.0.1-20170607-2300-nightly v1.0.1-20170606-2300-nightly v1.0.1-20170605-2300-nightly v1.0.1-20170604-2300-nightly v1.0.1-20170603-2300-nightly v1.0.1-20170602-2300-nightly v1.0.1-20170601-1255-preview v1.0.1-20170601-1221-preview v1.0.1-20170601-1157-preview v1.0.1-20170601-0934-preview v1.0.1-20170531-2300-nightly v1.0.1-20170530-2300-nightly v1.0.1-20170529-2300-nightly v1.0.1-20170528-2300-nightly v1.0.1-20170527-2300-nightly v1.0.1-20170526-2300-nightly v1.0.1-20170525-2300-nightly v1.0.1-20170524-2300-nightly v1.0.1-20170523-2300-nightly v1.0.1-20170523-1028-preview v1.0.1-20170522-2300-nightly v1.0.1-20170521-2300-nightly v1.0.1-20170520-2300-nightly v1.0.1-20170519-2300-nightly v1.0.1-20170518-2300-nightly v1.0.1-20170517-2300-nightly v1.0.1-20170516-2300-nightly v1.0.1-20170515-2300-nightly v1.0.1-20170514-2300-nightly v1.0.1-20170513-2300-nightly v1.0.1-20170512-2300-nightly v1.0.1-20170511-2300-nightly v1.0.1-20170510-2300-nightly v1.0.1-20170508-2300-nightly v1.0.1-20170507-2300-nightly v1.0.1-20170506-2300-nightly v1.0.1-20170505-2300-nightly v1.0.1-20170504-2300-nightly v1.0.1-20170503-2300-nightly v1.0.1-20170502-2300-nightly v1.0.1-20170501-2300-nightly v1.0.1-20170430-2300-nightly v1.0.1-20170429-2300-nightly v1.0.1-20170428-2300-nightly v1.0.1-20170427-2300-nightly v1.0.1-20170425-2300-nightly v1.0.1-20170424-2300-nightly v1.0.1-20170423-2300-nightly v1.0.1-20170422-2300-nightly v1.0.1-20170421-2300-nightly v1.0.1-20170420-2300-nightly v1.0.1-20170419-2300-nightly
Nothing to show
Clone or download
Latest commit 0494576 Sep 17, 2018

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 (8.11.x LTS HIGHLY RECOMENDED)

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

  1. 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 image

Start by reading the documentation for using AutoRest:

Developers image

Get yourself up and coding in AutoRest

Some related information:


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.