https://github.com/recruit-tech/agrios

:package::+1: Package your agreed server as axios adapter
https://github.com/recruit-tech/agrios

agreed ajax axios mock

Last synced: about 2 months ago
JSON representation

:package::+1: Package your agreed server as axios adapter

• Host: GitHub
• URL: https://github.com/recruit-tech/agrios
• Owner: recruit-tech
• License: mit
• Created: 2018-04-18T02:52:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-02-16T09:15:41.000Z (almost 5 years ago)
• Last Synced: 2024-10-06T08:17:51.052Z (3 months ago)
• Topics: agreed, ajax, axios, mock
• Language: JavaScript
• Homepage:
• Size: 268 KB
• Stars: 8
• Watchers: 22
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 

[![CircleCI](https://circleci.com/gh/recruit-tech/agrios.svg?style=svg)](https://circleci.com/gh/recruit-tech/agrios)

[![codecov](https://codecov.io/gh/recruit-tech/agrios/branch/master/graph/badge.svg)](https://codecov.io/gh/recruit-tech/agrios)

> :package::+1: Package your agreed server as [axios adapter][]

Agrios packages your `agree` file into [axios adapter][]. If you set it as the `adapter` of axios, then it gets responses from the `agree`s of your agreed files. See below for details.

# Install

    npm install --save-dev agrios

# Usage

First create adapter:

```js

const agrees = require('./path/to/agreed-file')

const agrios = require('agrios')

const agreedAdapter = agrios(agrees)

```

Then set it to your axios:

```js

const axios = require('axios')

axios.default.adapter = agreedAdapter

```

Then your axios calls get responses from the agreed files.

```js

axios.get('path/to/agreed-endpoint', { params: { some_key: 'some_value' } })

```

This doesn't make an acutual API request, but does get the response from the agreed files.

# API

```js

const agrios = require('agrios')

```

## agrios(agrees)

- @param {Object[]} agrees The list of agree objects

Creates the [axios adapter][] from the agreed definition array.

**NOTE**: Each item in `agrees` have to be an object. Unlike `agreed-server`, the string item (path of the agree file) is not supported.

If you have agreed root file like the below:

```js

module.exports = [

  './path/to/agree/foo.js',

  './path/to/agree/bar.js',

  './path/to/agree/baz.js',

  './path/to/agree/qux.js'

]

```

You need to rewrite it to:

```js

module.exports = [

  require('./path/to/agree/foo.js'),

  require('./path/to/agree/bar.js'),

  require('./path/to/agree/baz.js'),

  require('./path/to/agree/qux.js')

]

```

# License

MIT

[Axios adapter]: https://github.com/axios/axios/tree/master/lib/adapters