AutoRest - 具有 C# 和 Razor 模板的 Swagger 规范代码生成器。
簡介
AutoRest工具生成用于訪問 RESTful Web 服務的客戶端庫。AutoRest是使用OpenAPI 規范格式描述 REST API 的規范。
AutoRest 是一個提供代碼生成框架的工具,用于將 OpenAPI 2.0 和 3.0 規范轉換為客戶端庫,用于這些規范所描述的服務。它是在 OpenAPI Initiative 形成時由 Microsoft 開發的,以便 Azure 服務團隊可以開始根據新的 Swagger 和 OpenAPI 2.0 規范生成生成的客戶端庫。AutoRest 創建了一些擴展來增強 swagger 功能(由于 OpenAPI2 的缺點而創建了很多)。
AutoRest 的核心是一個靈活的管道,其中一系列預先配置的階段轉換和合并各種 OpenAPI 輸入文件,以生成可由特定語言代碼生成器使用的“代碼模型”。這些代碼生成器擴展將解釋代碼模型并生成符合每種語言的設計指南的代碼。為一種語言生成的代碼將使用相應的 Azure Core 實現,以便我們可以為生成的代碼中如何發出 HTTP 請求提供可配置的行為。
安裝 AutoRest
?安裝Node.js?使用安裝 AutoRest
#根據您的配置,您可能需要提升權限或 root 才能運行它。(在 OSX/Linux 上使用 'sudo') npm install-g autorest使用 AutoRest 生成客戶端
AutoRest 的第一步通常從生成單個 OpenAPI 文件開始。我們還將通過逐步構建命令行來展示如何在生成期間設置選項。
具體步驟
第一步是讓您的客戶端的 OpenAPI 文件定義。
autorest接下來,我們要告訴 AutoRest 生成哪個 swagger 文件。我們通過將 swagger 文件傳遞來做到這一點.
autorest?--input-file=pets.json我們還需要告訴 AutoRest 我們希望我們的 SDK 使用哪種語言,我們使用我們的語言標志來指定。為了這個例子,假設我們要生成 Python 代碼。將此添加到我們的命令行中,我們得到
autorest?--input-file=pets.json?--python在我們的最后一步中,我們可以告訴 AutoRest 在哪里輸出生成的 SDK。默認情況下 AutoRest 在輸出文件夾中生成文件./generated。但是,我們可以使用 flag 修改輸出文件夾--output-folder,我們有:
autorest?--input-file=pets.json?--python?--output-folder=myFolder/您可以在生成時指定許多其他標志。作為一個附加組件,假設我們想要在 namespace 下生成我們的代碼pets。
autorest?--input-file=pets.json?--python?--output-folder=myFolder/?--namespace=pets我們使用 AutoRest 生成的基本示例到此結束
Github地址
https://github.com/Azure/autorest
最后大家如果喜歡我的文章,還麻煩給個關注并點個贊, 希望net生態圈越來越好!
總結
以上是生活随笔為你收集整理的AutoRest - 具有 C# 和 Razor 模板的 Swagger 规范代码生成器。的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 朋友公司招聘用的一套C#基础面试题,10
- 下一篇: Xamarin效果第十六篇之GIS添加M