Miss any of our Open RFC calls?Watch the recordings here! »

autorest

3.0.6247 • Public • Published

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 (node 10.16.x LTS is a bare minimum, node 12 and 13 have some great performance benfits.)

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:

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.

Install

npm i autorest

DownloadsWeekly Downloads

24,659

Version

3.0.6247

License

MIT

Unpacked Size

11.5 MB

Total Files

25

Last publish

Collaborators

  • avatar
  • avatar
  • avatar