栏目分类:
子分类:
返回
终身学习网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
终身学习网 > IT > 软件开发 > 后端开发 > Java

使用AutoRest生成客户端程序

Java 更新时间:发布时间: 百科书网 趣学号

AutoRest是一个可以根据restful接口生成客户端代码的工具,大概流程就是输入一个符合OpenAPI规范的REST API描述文件,然后这个工具会将这些描述转化为具体的客户端代码。(项目地址)

下边来描述一下简单的使用过程:

        1.安装,使用npm

#安装
npm install -g autorest

#查看安装结果
autorest --help

#更新
autorest --latest

         2.用vs创建一个api项目,并使用openapi

        勾选使用openapi

        3.修改startup的ConfigureServices中的配置swagger代码

红框中代码如下,这段代码是将方法名称设置为处理对应的operationid。这里的operationid是用来区分不同的请求,要求必须唯一。工具会根据operationid和tag进行代码生成。

                c.CustomOperationIds(apiDescription =>
                {
                    return apiDescription.TryGetMethodInfo(out MethodInfo methodInfo) ? methodInfo.Name : null;
                });

        4.然后启动程序 ,点击链接,保存openapi文件

         右键另存为,例如保存到D:test,为swagger.json。

         5.在D:test创建autorest.md文件,并填入下边内容  ,此文档详细说明。

                这里表明了读取的openapi文件,生成客户端使用typescript和输出文件的目录

# Test API

# 一个魔法语句
> see https://aka.ms/autorest

```yaml
input-file: swagger.json
typescript: true
output-folder: myFolder/
```

        6.cd到D:test执行autorest autorest.md,文件生成完毕

         ​​​​​​​

        类似的工具有swagger-codegen

 

转载请注明:文章转载自 www.051e.com
本文地址:http://www.051e.com/it/295142.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 ©2023-2025 051e.com

ICP备案号:京ICP备12030808号