帮酷LOGO
  • 显示原文与译文双语对照的内容
Use your API Swagger definition to generate the Node.js ES6-compliant code of your API.

  • 源代码名称:swagger-node-codegen
  • 源代码网址:http://www.github.com/fmvilas/swagger-node-codegen
  • swagger-node-codegen源代码文档
  • swagger-node-codegen源代码下载
  • Git URL:
    git://www.github.com/fmvilas/swagger-node-codegen.git
  • Git Clone代码到本地:
    git clone http://www.github.com/fmvilas/swagger-node-codegen
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/fmvilas/swagger-node-codegen
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • OpenAPI Node.js
    代码生成器



    使用你的API OpenAPI 3 。x/for 2定义为你的API生成 node.js ES7-compliant代码。

    生成的代码功能:

    • ES7
    • ESLint
    • YAML配置文件
    • 表示式
    • 无 transpiling

    安装

    要从CLI使用它:

    npm install -g swagger-node-codegen

    要将它的用作项目中的模块,请执行以下操作:

    npm install --save swagger-node-codegen

    要求

    • Node.js v7.6 +

    用法

    从命令行接口( CLI )

     Usage: snc [options] <swaggerFile> Options:
     -V, --version output the version number
     -o, --output <outputDir> directory where to put the generated files (defaults to current directory)
     -t, --templates <templateDir> directory where templates are located (defaults to internal nodejs templates)
     -h, --help output usage information
    示例

    最短可能的语法:

    snc swagger.yaml

    指定放置生成代码的位置:

    snc swagger.yaml -o./my-api

    作为你的项目中的一个模块

    constpath=require('path');constcodegen=require('swagger-node-codegen');constswagger=require('./swagger.json');codegen.generate({
     swagger,
     target_dir:path.resolve(__dirname, './my-api')
    }).then(() => {
     console.log('Done!');
    }).catch(err=> {
     console.error(`Something went wrong: ${err.message}`);
    });

    swagger 参数可以是JSON或者指向JSON或者YAML文件的路径。

    constpath=require('path');constcodegen=require('swagger-node-codegen');codegen.generate({
     swagger:path.resolve(__dirname, './swagger.yml'),
     target_dir:path.resolve(__dirname, './my-api')
    }).then(() => {
     console.log('Done!');
    }).catch(err=> {
     console.error(`Something went wrong: ${err.message}`);
    });
    使用异步/等待

    函数 codegen.generate 返回 Promise,因此它意味着你可以使用异步/等待:

    constpath=require('path');constcodegen=require('swagger-node-codegen');try {
     awaitcodegen.generate({
     swagger:path.resolve(__dirname, './swagger.yml'),
     target_dir:path.resolve(__dirname, './my-api')
     });
     console.log('Done!');
    } catch (err) {
     console.error(`Something went wrong: ${err.message}`);
    }

    API文档

    模块

    codegen

    这个模块使用 openapi/swagger生成一个API的代码框架。

    为给定 openapi/swagger文件的API生成代码骨架。

    命令行程序

    这个模块使用 openapi/swagger生成一个API的代码框架。

    为给定 openapi/swagger文件的API生成代码骨架。

    参数类型说明
    配置Object.处理器升级选项
    config.swaggerObject | Stringopenapi/swagger JSON或者指向 openapi/swagger文件的字符串。
    config.target_dirString将生成文件的目录路径。
    config.templatesString自定义模板为( 可选)的目录路径。

    模板

    你可以创建自己的模板

    作者




    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语