前言
在 Web 开发中，前端的工作负责展示给用户的界面和交互逻辑。而前端开发离不开后端的支持，后端提供了数据和业务逻辑。在与后端协作的过程中，前端需要调用后端接口来获取数据和完成业务流程。而接口的生成和维护是后端开发的工作，通常会使用 AutoRest 这样的工具来自动生成接口代码，减少了开发者的代码工作。
本文介绍了 Microsoft 推出的一个自动生成 Ruby 接口代码的 npm 包 @microsoft.azure/autorest.ruby 并提供了使用教程。
什么是 @microsoft.azure/autorest.ruby
Autorest 是一款由 Microsoft 推出的用于自动生成各种编程语言的 RESTful API 的工具。而 @microsoft.azure/autorest.ruby 是 Autorest 的 Ruby 语言插件。使用该插件，便可轻松地实现 Ruby 的客户端代码和相关文档的自动生成。
值得一提的是，@microsoft.azure/autorest.ruby 的自动化生成代码符合 Ruby on Rails 项目的编码规范和约定，验证、错误处理和分页等基础特性都被封装进了生成的代码里。
安装和使用
安装
使用 npm 安装 Node 包。
npm install -g autorest npm install -g @microsoft.azure/autorest.ruby
配置
在安装完 @microsoft.azure/autorest.ruby 之后，需要通过配置文件指定该插件。
在项目根目录下新建 autorest.yaml 文件，该文件用于指定 AutoRest 如何读取源文件以及其他相关配置信息。以下是一个示例配置文件。
input-file: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/storage/data-plane/Microsoft.BlobStorage/stable/2019-02-02/blob.json ruby: true add-credentials: true namespace: TestClient output-folder: ./generated/
其中， input-file 指定了用于生成代码的 Swagger 规范。ruby: true 字段告诉 Autorest 使用 Ruby 语言插件。add-credentials 设置为 true 将启用 HTTP 认证。namespace 指定了生成的命名空间。output-folder 指定了生成代码的输出路径。
自动生成代码
要使用 @microsoft.azure/autorest.ruby 自动生成代码，可以在命令行中运行以下命令：
autorest automain.yaml
其中，automain.yaml 是当前项目根目录下的一个配置文件。执行此操作后，自动生成 Ruby 代码和相关文档，保存在 output-folder 指定的目录中。
代码使用
使用生成的代码，只需在自己的代码中包含代码并调用相关函数即可。
example.rb
-- -------------------- ---- -------
---------------- ---------------------------
---------------- -----------------------------------
- ---- ---- ------- ------------
- --- -- --- --- --------- ---------- ----
-
- -- ------- - --- -------- -- --- -------
- ------------- -- - ----- --- -----
- - ------- -- --- - ---- -- ----- ------
- -- --- ----- ---- ------- --------
------ - --------------
------------------ - -----------------------------------------
------ - -----------------------------------------
-----------------
---- --------------代码中 require_relative 表示该行引用了由 autorest 自动生成的 Ruby 文件。
结语
本文介绍了 @microsoft.azure/autorest.ruby 插件的使用教程。该插件通过配置文件即可自动生成 Ruby 代码和相关文档，编写方便，使用愉快。希望大家可以在自己的项目中尝试使用，请大家留意相关使用文档，更好的运用自动生成代码给我们开发带来更大的便利。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bcc967216659e244778