OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python
Перейти к файлу
Mike Harder 3d50bb1315
[v2] Report full error for schema violations (#4934)
- Fixes #4933
2024-03-29 16:56:49 -07:00
.attic Updating documentation 2019-02-11 12:40:15 -08:00
.gulp update packaging scripts 2020-03-12 13:55:05 -07:00
.scripts Transition `autorest.v2` release pipelines to `1es-templates` (#4932) 2024-03-27 11:34:40 -07:00
.vscode
Samples suppressing batch messages when message format is json or yaml (#3069) 2019-01-24 11:23:54 -08:00
docs Merge pull request #3306 from Azure/customizations-doc 2019-10-16 08:24:58 -07:00
eng Transition `autorest.v2` release pipelines to `1es-templates` (#4932) 2024-03-27 11:34:40 -07:00
schema [v2] Backport "Allow x-ms-paths not to start with /" (#4152) (#4930) 2024-03-25 15:29:28 -07:00
src [v2] Report full error for schema violations (#4934) 2024-03-29 16:56:49 -07:00
.gitattributes
.gitignore
.travis.yml
ChangeLog.md
LICENSE
README.md Merge pull request #3220 from kumarRaj/patch-2 2019-04-26 07:50:54 -07:00
gulpfile.js
package.json Fix null write error with node 14 for Autorest V2 (#3985) 2021-03-15 09:46:49 -07:00
tslint.json

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 (10.15.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.