Skip to content

Commit ceff945

Browse files
committed
updated readMe
1 parent 003b7ea commit ceff945

1 file changed

Lines changed: 46 additions & 2 deletions

File tree

README.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,47 @@
1-
# appium-plugin-template
1+
# appium-interceptor-plugin
2+
3+
This is an Appium plugin designed to intercept API response and mocking easy.
4+
This plugin uses mitmproxy
5+
6+
## Prerequisite
7+
8+
Appium version 2.0
9+
10+
## Installation - Server
11+
12+
Install the plugin using Appium's plugin CLI, either as a named plugin or via NPM:
13+
14+
```shell
15+
appium plugin install --source=npm appium-interceptor-plugin
16+
```
17+
18+
## Activation
19+
20+
The plugin will not be active unless turned on when invoking the Appium server:
21+
22+
`appium server -ka 800 --use-plugins=appium-interceptor -pa /wd/hub`
23+
24+
## Supported Platforms
25+
26+
💚 `Android`
27+
28+
### what does this plugin do?
29+
30+
Plugin will set proxy to the device and intercept the API response and mock the response based on the request.
31+
32+
**Mocking support**
33+
34+
1. Mocking response based on the request
35+
2. Mocking response based on the request and response
36+
3. Mocking response based on the request and response and request body
37+
4. Mocking request headers
38+
5. Mocking partial response from server
39+
40+
### Usage
41+
Refer Examples [here](./test/plugin-test.js)
42+
## Build local
43+
`npm install`
44+
45+
`npm run build`
46+
247

3-
Run command: npm install

0 commit comments

Comments
 (0)