xiaoyaoji-mock-server

KO | EN

gitlite — search

#hacktoberfest #react #typescript #llm #go #rust #docker #macos #awesome #cli #vue #pytorch #security #open-source

xiaoyaoji-mock-server

(★ 10)

针对小幺鸡的自动化 mock 工具，特别适用前后端分离的开发模式

xiaoyaoji-mock-server 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# xiaoyaoji-mock-server

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![gemnasium deps][gemnasium-image]][gemnasium-url]
[![npm download][download-image]][download-url]

[npm-image]: http://img.shields.io/npm/v/xiaoyaoji-mock-server.svg?style=flat-square
[npm-url]: http://npmjs.org/package/xiaoyaoji-mock-server
[travis-image]: https://img.shields.io/travis/alcat2008/xiaoyaoji-mock-server.svg?style=flat-square
[travis-url]: https://travis-ci.org/alcat2008/xiaoyaoji-mock-server
[coveralls-image]: https://img.shields.io/coveralls/alcat2008/xiaoyaoji-mock-server.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/alcat2008/xiaoyaoji-mock-server?branch=master
[gemnasium-image]: http://img.shields.io/gemnasium/alcat2008/xiaoyaoji-mock-server.svg?style=flat-square
[gemnasium-url]: https://gemnasium.com/alcat2008/xiaoyaoji-mock-server
[node-image]: https://img.shields.io/badge/node.js-%3E=_0.10-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[download-image]: https://img.shields.io/npm/dm/xiaoyaoji-mock-server.svg?style=flat-square
[download-url]: https://npmjs.org/package/xiaoyaoji-mock-server

The tool is designed to get you up and running with a mocker server for xiaoyaoji.

## Requirements
* node `>=7.6.0.`
* npm `>=5.6.0`

## Getting Started

After confirming that your development environment meets the specified [requirements](#requirements), you can follow these steps to get the project up and running:

```bash
$ git clone <url>
$ cd xiaoyaoji-mock-server
$ npm install                   # Install project dependencies
$ npm start                     # Compile and launch
```

Then visit [http://127.0.0.1:5000/](http://127.0.0.1:5000/)

## Profile

The structure of 'profile.json' file is shown below.

```javascript
{
  "host": "",                    // xiaoyaoji host, such as 'http://api.com/'
  "projectId": "",               // project's id
  "token": "",                   // find in your browser's storage
  "inject": {                    // can custom some api here
    "<custom url>": {
      "code": 1,
      "errmsg": "我是被注入的"
    }
  },
  "dict": {                      // get with selected dict field
    "<field name>": ["1", "2"]
  }
}
```

## Usage

### Use `xiaoyaoji-mock-server` in current project

Installation:

[![xiaoyaoji-mock-server](https://nodei.co/npm/xiaoyaoji-mock-server.png)](https://npmjs.org/package/xiaoyaoji-mock-server)

```bash
npm install --save-dev xiaoyaoji-mock-server
```

Then, add `mock` to [npm scripts](https://docs.npmjs.com/misc/scripts):

```json
{
  "scripts": {
    "mock": "xiaoyaoji-mock-server --file=<profile path>"
  }
}
```

**Note:** please make sure that `profile` exists.

Now, just run `npm run mock`.

## Documentation

### CLI

We can install `xiaoyaoji-mock-server` as a cli command and explore what it can do by `xiaoyaoji-mock-server -h`. However, the recommended way to use `xiaoyaoji-mock-server` is to install it as `devDependencies`.

```bash
$ npm install -g xiaoyaoji-mock-server
$ xiaoyaoji-mock-server -h
  Usage: xiaoyaoji-mock-server [options]

Options:

-h, --help           output usage information
    -V, --version        output the version number
    -f, --file <path>    specify path of profile, defaults to [./profile.json]
    -p, --port [number]  set server port, defaults to [5000]
    -pf, --prefix [prefix]', 'prefix placeholder array, split by \',\'', defaults to ['$prefix$']
```

#### port: Number

> default: 5000

To set the port which will be listened when we start a local server.

#### file: String

> default: './profile.json'

To set profile path.

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.<br>
Open [http://localhost:5000](http://localhost:5000) to view it in the browser.

The page will reload if you make edits.<br>
You will also see any lint errors in the console.

Attention: The host must be specified!

## Todos

- ~~mock api~~
- ~~inject, dict~~
- show api list
- auto test
- xiaoyaoji api definition validator
- multiple project support

xiaoyaoji-mock-server

xiaoyaoji-mock-server 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

xiaoyaoji-mock-server

xiaoyaoji-mock-server 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README