簡介

AutoRest工具生成用于訪問 RESTful Web 服務(wù)的客戶端庫。AutoRest是使用OpenAPI 規(guī)范格式描述 REST API 的規(guī)范。

AutoRest 是一個提供代碼生成框架的工具，用于將 OpenAPI 2.0 和 3.0 規(guī)范轉(zhuǎn)換為客戶端庫，用于這些規(guī)范所描述的服務(wù)。它是在 OpenAPI Initiative 形成時由 Microsoft 開發(fā)的，以便 Azure 服務(wù)團隊可以開始根據(jù)新的 Swagger 和 OpenAPI 2.0 規(guī)范生成生成的客戶端庫。AutoRest 創(chuàng)建了一些擴展來增強 swagger 功能（由于 OpenAPI2 的缺點而創(chuàng)建了很多）。

AutoRest 的核心是一個靈活的管道，其中一系列預(yù)先配置的階段轉(zhuǎn)換和合并各種 OpenAPI 輸入文件，以生成可由特定語言代碼生成器使用的“代碼模型”。這些代碼生成器擴展將解釋代碼模型并生成符合每種語言的設(shè)計指南的代碼。為一種語言生成的代碼將使用相應(yīng)的 Azure Core 實現(xiàn)，以便我們可以為生成的代碼中如何發(fā)出 HTTP 請求提供可配置的行為。

安裝 AutoRest

?安裝Node.js?使用安裝 AutoRest

#根據(jù)您的配置，您可能需要提升權(quán)限或 root 才能運行它。（在 OSX/Linux 上使用 'sudo'） npm install-g autorest

使用 AutoRest 生成客戶端

AutoRest 的第一步通常從生成單個 OpenAPI 文件開始。我們還將通過逐步構(gòu)建命令行來展示如何在生成期間設(shè)置選項。

具體步驟

第一步是讓您的客戶端的 OpenAPI 文件定義。

autorest

接下來，我們要告訴 AutoRest 生成哪個 swagger 文件。我們通過將 swagger 文件傳遞來做到這一點.

autorest?--input-file=pets.json

我們還需要告訴 AutoRest 我們希望我們的 SDK 使用哪種語言，我們使用我們的語言標(biāo)志來指定。為了這個例子，假設(shè)我們要生成 Python 代碼。將此添加到我們的命令行中，我們得到

autorest?--input-file=pets.json?--python

在我們的最后一步中，我們可以告訴 AutoRest 在哪里輸出生成的 SDK。默認情況下 AutoRest 在輸出文件夾中生成文件./generated。但是，我們可以使用 flag 修改輸出文件夾--output-folder，我們有：

autorest?--input-file=pets.json?--python?--output-folder=myFolder/

您可以在生成時指定許多其他標(biāo)志。作為一個附加組件，假設(shè)我們想要在 namespace 下生成我們的代碼pets。

autorest?--input-file=pets.json?--python?--output-folder=myFolder/?--namespace=pets

我們使用 AutoRest 生成的基本示例到此結(jié)束

Github地址

https://github.com/Azure/autorest

最后大家如果喜歡我的文章，還麻煩給個關(guān)注并點個贊, 希望net生態(tài)圈越來越好！

總結(jié)

以上是生活随笔為你收集整理的AutoRest - 具有 C# 和 Razor 模板的 Swagger 规范代码生成器。的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。