Newlywed Party Monsters

    @prequest/response-types-server
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.2 • Public • Published

    @prequest/response-types-server

    Restful-API 响应的 JSON 数据的 TypeScript 类型生成器

    前言

    在前端项目中,没有 fs 等 API,导致不能在运行时,动态生成 Restful-API 响应的 JSON 数据的类型文件。

    因而我尝试开发了 @prequest/response-types-generator,它根据配置,可以发起请求和解析响应,最后生成类型文件。但缺点也很明显,需要将要项目中请求的接口一个一个配置到配置文件中。普通的 Get 请求还好说,但对于 Post 请求,一些复杂的传参,也不是很好处理。

    本项目解决了上述问题。原理非常简单,首先开启一个 Http Server,然后在前端项目的请求库中间件中,将请求的参数和响应结果,通过一个新的请求实例,发送到 Http Server 中,Http Server 根据传参,利用 fs API 向指定目录生成类型文件即可。

    项目分为两部分 @prequest/response-types-server@prequest/response-types-client

    安装

    npm install @prequest/response-types-server

    使用

    开启服务器

    import server from '@prequest/response-types-server'
    
    // 默认开启的端口为 10086
    server()
    
    // 你可以通过传参指定端口
    server({ port: 10010 })

    生成类型文件

    HTTP Server 只接收 POST 与 OPTIONS 请求,当 HTTP Body 传输的数据满足下列参数列表,则会向指定目录输出类型文件

    参数 类型 含义
    outPutDir string 类型文件输出目录
    outPutName string 文件名称
    overwrite boolean 文件可复写
    data Json 要解析的 Json 数据
    interfaceName string 导出的接口名称

    响应

    HTTP Server 只接收到请求后,会返回下列内容

    参数 类型 含义
    status boolean 操作成功与否
    timestamp number 时间戳
    error Error 错误信息
    data string[] 生成的类型文件列表。前端可根据这个列表,判断是否需要再次发起请求

    Install

    npm i @prequest/response-types-server

    DownloadsWeekly Downloads

    2

    Version

    1.5.2

    License

    MIT

    Unpacked Size

    30.1 kB

    Total Files

    13

    Last publish

    Collaborators

    • thomas_han