# swagger-mock-maker

> 一个简单的 Swagger 文档解析器，支持生成演示数据与数据实体类

Latest version **1.1.4** (published 2020-02-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install swagger-mock-maker
pnpm add swagger-mock-maker
yarn add swagger-mock-maker
bun add swagger-mock-maker
```

## 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.1.4 |
| Published | 2020-02-28 |
| First published | 2020-02-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jesse |
| Maintainers | jesse1004 |
| Keywords | easy-mock, mock, swagger |

## Links

- npm: https://www.npmjs.com/package/swagger-mock-maker
- Repository: https://github.com/jmx164491960/swagger-parser-mock
- Homepage: https://github.com/jmx164491960/swagger-parser-mock#readme
- Issues: https://github.com/jmx164491960/swagger-parser-mock/issues
- npm.io page: https://npm.io/package/swagger-mock-maker

## Dependencies (4)

- [url](https://npm.io/package/url.md) ^0.11.0
- [memoizee](https://npm.io/package/memoizee.md) ^0.4.14
- [swagger-tools](https://npm.io/package/swagger-tools.md) ^0.10.4
- [swagger-client](https://npm.io/package/swagger-client.md) ^3.8.22

## Alternatives

- [pagerjs](https://npm.io/package/pagerjs.md) — 60 weekly downloads
- [whistle.savefor-mock](https://npm.io/package/whistle.savefor-mock.md) — 4 weekly downloads
- [@growupsell/mock](https://npm.io/package/@growupsell/mock.md) — 0 weekly downloads
- [afrifake](https://npm.io/package/afrifake.md) — 0 weekly downloads
- [xsd-faker-locales](https://npm.io/package/xsd-faker-locales.md) — 0 weekly downloads

## Recent versions

- 1.1.4 (latest) — 2020-02-28
- 1.1.3 — 2020-02-28

## README

# Swagger Parser Mock

[![npm version](https://img.shields.io/npm/v/swagger-parser-mock.svg?style=flat-square)](https://www.npmjs.com/package/swagger-parser-mock)

一个简单的 Swagger 文档解析器，支持生成演示数据与数据实体类。 

## Features

- 支持 OpenAPI Specification ([1.2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md) & [2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) & [3.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md))
- 支持为 Parameters 与 Responses 生成演示数据
- 支持根据 Schema 生成数据实体类（JavaScript/Objective-C）

## API

### swaggerParserMock(url, opts)

- 参数说明见 [swagger-js](https://github.com/swagger-api/swagger-js#constructor-and-methods)

```js
const swaggerParserMock = require('swagger-parser-mock')
const specs = swaggerParserMock('http://petstore.swagger.io/v2/swagger.json')

specs.then(docs => {
  const api = docs.paths['/store/order']['post']
  const example = api.responses['200'].example
  console.log(JSON.parse(example))
  // =>
  /**
   * { id: '@integer(60, 100)',
   *   petId: '@integer(60, 100)',
   *   quantity: '@integer(60, 100)',
   *   shipDate: '@datetime',
   *   status: 'placed',
   *   complete: '@boolean' }
   */
})
```

### getJavaScriptEntities(schema)

```js
const swaggerParserMock = require('swagger-parser-mock')
const {
  getJavaScriptEntities,
  getObjectiveCEntities
} = require('swagger-parser-mock/lib/entity')
const specs = swaggerParserMock('http://petstore.swagger.io/v2/swagger.json')

specs.then(docs => {
  const api = docs.paths['/store/order']['post']
  const orderEntity = getJavaScriptEntities(api.responses['200'])[0]
  console.log(orderEntity)
  // =>
  /**
   * class Order {
   *   constructor() {
   *     this.id = 0;
   *     this.petId = 0;
   *     this.quantity = 0;
   *     this.shipDate = '';
   *     this.status = '';
   *     this.complete = false;
   *   }
   * }
   */
})
```

### getObjectiveCEntities(schema)

```js
// ...
specs.then(docs => {
  const api = docs.paths['/store/order']['post']
  const orderEntity = getObjectiveCEntities(api.responses['200'])[0]
  console.log(orderEntity)
  // =>
  /**
   * @interface Order : NSObject
   * @property (nonatomic, strong) NSNumber *id;
   * @property (nonatomic, strong) NSNumber *petId;
   * @property (nonatomic, strong) NSNumber *quantity;
   * @property (nonatomic, copy) NSString *shipDate;
   * @property (nonatomic, copy) NSString *status;
   * @property (nonatomic, assign) BOOL complete;
   * @end
   */
})
```

## License

MIT

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