# openapi-flowtype-definition

> OpenAPI 2.0 Flowtype definition

Latest version **1.0.1** (published 2016-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install openapi-flowtype-definition
pnpm add openapi-flowtype-definition
yarn add openapi-flowtype-definition
bun add openapi-flowtype-definition
```

## 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.1 |
| Published | 2016-11-11 |
| First published | 2016-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Albert Brand |
| Maintainers | albertbrand |

## Links

- npm: https://www.npmjs.com/package/openapi-flowtype-definition
- npm.io page: https://npm.io/package/openapi-flowtype-definition

## Recent versions

- 1.0.1 (latest) — 2016-11-11

## README

# OpenAPI 2.0 Flowtype definition

This repo contains [Flowtype](https://flowtype.org/) annotations for the
[OpenAPI 2.0](http://swagger.io/specification/) (or Swagger 2.0) JSON format. It
uses
[exact object types](https://flowtype.org/docs/objects.html#exact-object-types)
for each specified OpenAPI object and doesn't allow vendor extensions.

## Install

```
npm i --save-dev openapi-flowtype-definition
```

or

```
yarn add --dev openapi-flowtype-definition
```

## How to use

Assuming that your project is set up with Flowtype, import the type whenever you
need to type check a JS object containing the OpenAPI definition:

```
import type { OpenAPI } from 'openapi-flowtype-definition';

const api: OpenAPI = {
  swagger: "2.0",
  // etc...
}
```

See the example under `./example` for more examples.

---
_Source: https://npm.io/package/openapi-flowtype-definition · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._