# AutoRest

> AutoRest is an open source Microsoft tool (MIT) that generates client libraries for accessing RESTful web services from OpenAPI 2.0 (Swagger) and OpenAPI 3.0 specifications. It is the generator behind the Azure SDKs across C#, Python, Java, TypeScript, Go, PowerShell and Swift, built on a pipeline of npm-distributed plugins. AutoRest is DEPRECATED and retires on 2026-07-01; the recommended successor is TypeSpec.

> Generated by API Evangelist from the project's public GitHub repository on 2026-08-06. AutoRest does not publish an llms.txt of its own — it operates no website or docs host, so there is no origin to serve one from. Everything below was fetched from github.com/Azure/autorest.

## Status

- [Deprecation notice](https://github.com/Azure/autorest/blob/main/readme.md): Deprecated; retirement 2026-07-01; no new features, language generators or plugins.
- [Deprecation tracking issue #5175](https://github.com/Azure/autorest/issues/5175): The public thread carrying the retirement plan.
- [TypeSpec](https://typespec.io/): The named replacement — Microsoft's actively developed API description language and code generation platform.

## Install and run

- [Installing AutoRest](https://github.com/Azure/autorest/blob/main/docs/install/readme.md): `npm install -g autorest`; requires Node.js.
- [Command line interface](https://github.com/Azure/autorest/blob/main/docs/user/command-line-interface.md): `autorest [config-file.md|json|yaml] [options]`; configuration file is the preferred surface, flags override it.
- [Configuration files](https://github.com/Azure/autorest/blob/main/docs/user/configuration.md): Literate Markdown configuration; `readme.md` is the default.
- [Index of AutoRest flags](https://github.com/Azure/autorest/blob/main/docs/generate/flags.md): 106 documented flags, grouped by generator.
- [AutoRest versioning](https://github.com/Azure/autorest/blob/main/docs/install/autorest-versioning.md): CLI / core module / extension version pinning with `--version:` and `--use:`.
- [Docker images](https://github.com/Azure/autorest/blob/main/docs/docker.md): `azsdkengsys.azurecr.io/azuresdk/autorest` and per-language variants.

## Using OpenAPI with AutoRest

- [Defining your API with OpenAPI](https://github.com/Azure/autorest/blob/main/docs/openapi/readme.md)
- [AutoRest extensions for OpenAPI 2.0](https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md): The `x-ms-*` vendor extension vocabulary (29 terms) AutoRest reads to shape generated clients.
- [Prechecker](https://github.com/Azure/autorest/blob/main/docs/openapi/prechecker.md): Validation applied to input documents before modeling.
- [Directives](https://github.com/Azure/autorest/blob/main/docs/generate/directives.md): JSONPath-targeted transforms over the input document.
- [Built-in directives](https://github.com/Azure/autorest/blob/main/docs/generate/built-in-directives.md)
- [How AutoRest generates code from OpenAPI](https://github.com/Azure/autorest/blob/main/docs/generate/how-autorest-generates-code-from-openapi.md)

## Packages

- [autorest](https://www.npmjs.com/package/autorest): The CLI (3.8.0).
- [@autorest/core](https://www.npmjs.com/package/@autorest/core): The pipeline engine (3.10.9).
- [@autorest/modelerfour](https://www.npmjs.com/package/@autorest/modelerfour): Schema normalization into the shared code model (4.27.3).
- [@autorest/csharp](https://www.npmjs.com/package/@autorest/csharp) · [@autorest/python](https://www.npmjs.com/package/@autorest/python) · [@autorest/java](https://www.npmjs.com/package/@autorest/java) · [@autorest/typescript](https://www.npmjs.com/package/@autorest/typescript) · [@autorest/go](https://www.npmjs.com/package/@autorest/go) · [@autorest/powershell](https://www.npmjs.com/package/@autorest/powershell): Language generators.
- [@autorest/openapi-to-typespec](https://www.npmjs.com/package/@autorest/openapi-to-typespec): Scaffolds TypeSpec from OpenAPI — the migration path.

## Source repositories

- [Azure/autorest](https://github.com/Azure/autorest): Core, modeler, CLI, docs.
- [Azure/autorest.csharp](https://github.com/Azure/autorest.csharp) · [Azure/autorest.python](https://github.com/Azure/autorest.python) · [Azure/autorest.java](https://github.com/Azure/autorest.java) · [Azure/autorest.typescript](https://github.com/Azure/autorest.typescript) · [Azure/autorest.go](https://github.com/Azure/autorest.go) · [Azure/autorest.powershell](https://github.com/Azure/autorest.powershell)

## Releases and support

- [Release notes](https://github.com/Azure/autorest/blob/main/docs/releases/readme.md): Milestone notes through July 2022.
- [@autorest/core changelog](https://github.com/Azure/autorest/blob/main/packages/extensions/core/CHANGELOG.md): Per-package chronus changelog; current 3.10.9 (2026-04-09).
- [GitHub releases](https://github.com/Azure/autorest/releases): Prerelease build artifacts.
- [Issues](https://github.com/Azure/autorest/issues) · [Discussions](https://github.com/Azure/autorest/discussions)
- [Troubleshooting](https://github.com/Azure/autorest/blob/main/docs/troubleshooting.md) · [FAQ](https://github.com/Azure/autorest/blob/main/docs/faq.md)
- [Migrating from AutoRest 2.0 to 3.0](https://github.com/Azure/autorest/blob/main/docs/migrate/readme.md)

## Security and license

- [SECURITY.md](https://github.com/Azure/autorest/blob/main/SECURITY.md): Report vulnerabilities to the Microsoft Security Response Center (https://msrc.microsoft.com/create-report) or secure@microsoft.com. Do not file security issues as public GitHub issues.
- [Microsoft Bug Bounty](https://aka.ms/opensource/security/bounty)
- [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd)
- [LICENSE](https://github.com/Azure/autorest/blob/main/LICENSE): MIT.

## Notes for agents

- AutoRest exposes NO HTTP API, no base URL, no authentication surface and no rate limits. It is a locally installed CLI. Any tool that plans to "call the AutoRest API" is mistaken.
- The only credentials AutoRest accepts (`--github-auth-token`, `GITHUB_AUTH_TOKEN`) are for reading OpenAPI input files from private GitHub repositories.
- For new work, generate from TypeSpec instead. AutoRest accepts no new features and retires 2026-07-01.