# node-red-contrib-swagger-js

> Swagger js for node-red

Latest version **1.0.3** (published 2021-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-red-contrib-swagger-js
pnpm add node-red-contrib-swagger-js
yarn add node-red-contrib-swagger-js
bun add node-red-contrib-swagger-js
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-09-13 |
| First published | 2021-09-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 246.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marcos Caputo |
| Maintainers | caputomarcos |
| Keywords | node-red, swagger client, api |

## Links

- npm: https://www.npmjs.com/package/node-red-contrib-swagger-js
- Repository: https://github.com/caputomarcos/node-red-contrib-swagger-js
- Homepage: https://github.com/caputomarcos/node-red-contrib-swagger-js#readme
- Issues: https://github.com/caputomarcos/node-red-contrib-swagger-js/issues
- npm.io page: https://npm.io/package/node-red-contrib-swagger-js

## Dependencies (1)

- [swagger-client](https://npm.io/package/swagger-client.md) ^3.12.2

## Recent versions

- 1.0.3 (latest) — 2021-09-13
- 1.0.2 — 2021-09-10
- 1.0.1 — 2021-09-10
- 1.0.0 — 2021-09-10

## README

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?hosted_button_id=FLB35ANBK99ZA)

<img src="icons/swagger.svg" width="128" height="128">

It is based on [swagger-js](https://github.com/swagger-api/swagger-js).


Inputs
------

### Name   -    string

set a manuell name for the node. If no name is set, the node sets the selected operation name.
### Container   -   string

The name of the container that will receive the API object. If no container is set, the node sets the selected API name.

### URL    -    string
set the full url domain name (incl. http:// / https://) for the OpenAPI document. By clicking on 'read' it will build the API and operation Selectors.

### API tag    -    enum
Preselector for the operation. Grouped by the 'tags' in each operation.

### Operation   -   enum
Selector for the OpenAPI operation. The selection name is set by the 'summary'. Behind the selector field is the (unique) operation id. By mouse-over it will show the full operation Description.

### Parameters  depending

If the selected operation has parameters, they will be listed here. The description can be found by mouse-over the parameter name. If the parameter is required, it will be marked with a red star behind the name. For Json Objects with defined keys there will be 3 Buttons: 'set required' and 'set default' will build a json-object with the correct key names and the necessary type info as the value. 'show keys' show all possible key parameters with additional info by mouse-over the key name.

Outputs
-------

### Container     -   object
Returns the complete API object.

Authentification
----------------
The credentials has to be set into msg.authentification.

`e.g. msg.authentification = "Bearer ******"`

Error handling
--------------

This handles how to react if the server returns a http status of 4xx or 5xx. You can find the last server response in msg.response.
#### Standard    -  string
The flow will move on normally so you can choose how to handle this within your flow.
#### Other output   -   string
The flow will move on in a second output.
#### Throw exception    -   string
The flow will throw an exception. This exception can be catched by the 'catch' node.

---
_Source: https://npm.io/package/node-red-contrib-swagger-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._