swagger-node-codegen - GitLite

KO | EN

gitlite — search

#python #react #typescript #android #machine-learning #rust #linux #nodejs #windows #kubernetes #awesome-list #pytorch #openai #open-source

swagger-node-codegen

(★ 199)

An OpenAPI 3.x/Swagger 2 code generator for Node.js

File Explorer

Download Latest Version (.zip)

- - extension.js
  - handlebars.js
- bundler.js
- codegen.js
- swagger2.js
- - .editorconfig
  - .eslintrc
  - .gitignore
  - package.json
  - README.md
- README.md
- - api-with-examples.yaml
  - callback-example.yaml
  - link-example.yaml
  - petstore-expanded.yaml
  - petstore.yaml
  - uspto.yaml
- - iris.yml
  - missing_description.yml
  - test.js
.editorconfig
.eslintignore
.eslintrc
.gitignore
.npmignore
cli.js
LICENSE
logo.ai
logo.png
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/fmvilas/swagger-node-codegen

Downloads the entire project code from GitHub to your computer.

cd swagger-node-codegen

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Node.js Node.js must be installed to use npm.

npm install -g swagger-node-codegen

Installs the package published on the npm registry globally — no need to clone the source.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install -g swagger-node-codegen

Installs the package published on the npm registry globally — no need to clone the source.

npm install --save swagger-node-codegen

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1>THIS PACKAGE IS NOT MAINTAINED ANYMORE. IF YOU WANT TO MAINTAIN IT DROP ME A LINE AT fran.mendez[at]hey.com.</h1>

<p align="center"><img src="logo.png"></p>
<p align="center">
  <strong>OpenAPI Node.js<br>Code Generator</strong>
</p>
<br><br>
Use your API OpenAPI 3.x/Swagger 2 definition to generate Node.js ES7-compliant code for your API.

The generated code features:

* ES7
* ESLint
* YAML config file
* Express
* No transpiling

## Install

To use it from the CLI:

```bash
npm install -g swagger-node-codegen
```

To use it as a module in your project:

```bash
npm install --save swagger-node-codegen
```

## Requirements

* Node.js v7.6+

## Usage

### From the command-line interface (CLI)

```bash
  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
```

#### Examples

The shortest possible syntax:
```bash
snc swagger.yaml
```

Specify where to put the generated code:
```bash
snc swagger.yaml -o ./my-api
```

### As a module in your project

```js
const path = require('path');
const codegen = require('swagger-node-codegen');
const swagger = 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}`);
});
```

The `swagger` parameter can be either JSON or a path pointing to a JSON or YAML file.

```js
const path = require('path');
const codegen = 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}`);
});
```
#### Using async/await

The function `codegen.generate` returns a Promise, so it means you can use async/await:

```js
const path = require('path');
const codegen = require('swagger-node-codegen');

try {
  await codegen.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 Documentation

### Modules

<dl>
<dt><a href="#module_codegen">codegen</a></dt>
<dd><p>This module generates a code skeleton for an API using OpenAPI/Swagger.</p>
</dd>
<dt><a href="#codegen.module_generate">generate</a> ⇒ <code>Promise</code></dt>
<dd><p>Generates a code skeleton for an API given an OpenAPI/Swagger file.</p>
</dd>
</dl>

<a name="module_codegen"></a>

### codegen
This module generates a code skeleton for an API using OpenAPI/Swagger.

<a name="codegen.module_generate"></a>

#### generate ⇒ <code>Promise</code>
Generates a code skeleton for an API given an OpenAPI/Swagger file.

| Param | Type | Description |
| --- | --- | --- |
| config | <code>Object</code> | Configuration options |
| config.swagger | <code>Object</code> \| <code>String</code> | OpenAPI/Swagger JSON or a string pointing to an OpenAPI/Swagger file. |
| config.target_dir | <code>String</code> | Path to the directory where the files will be generated. |
| config.templates| <code>String</code> | Path to the directory where custom templates are (optional). |

## Templates
You can create your own [templates](./templates/README.md).

## Authors

* Fran Méndez ([@fmvilas](http://twitter.com/fmvilas))
* Richard Klose ([@richardklose](http://github.com/richardklose))