# dev-proxy-server

**Repository Path**: mooselee/dev-proxy-server

## Basic Information

- **Project Name**: dev-proxy-server
- **Description**: 本地开发时可用的proxy代理插件
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-12-02
- **Last Updated**: 2024-12-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 介绍

本地开发时可用的proxy代理插件

## 如何使用

```cmd
npm i dev-proxy-server
```

```javascript
import proxyServer from 'dev-proxy-server';

proxyServer({
	port: 8080,
});
```

## 相关参数

ServerOptions
| prop | type | default | required |
| :--------- | :------ | :-------- | :------- |
| https | Boolean | false | false |
| port | Number | 3000 | false |
| proxyTable | Array | [] | false |
| outputPath | string | undefined | false |

ProxyTable
| prop | type | default | required |
| :--------- | :------ | :-------- | :------- |
| match | String | undefined | true |
| target | String | undefined | true |
| rewrite | Object | undefined | false |
| local | Boolean | false | false |

```typescript
interface Rewrite {
	[key: string]: string;
}

// 示例
const proxyTable = {
	match: '/api';
	target: 'http://dev.myapp.com';
	rewrite: {
        '^/api': '/api_dev'
    };
}
```

## Gitee

https://gitee.com/mooselee/dev-proxy-server