Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/americanexpress/one-app-dev-proxy
✨ Proxy requests to remote servers locally while also allowing for an express middleware to be provided and applied to all requests
https://github.com/americanexpress/one-app-dev-proxy
dev-proxy express express-middleware nodejs one-app proxy-requests
Last synced: 9 days ago
JSON representation
✨ Proxy requests to remote servers locally while also allowing for an express middleware to be provided and applied to all requests
- Host: GitHub
- URL: https://github.com/americanexpress/one-app-dev-proxy
- Owner: americanexpress
- License: apache-2.0
- Created: 2019-11-22T17:58:18.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T15:11:11.000Z (7 months ago)
- Last Synced: 2024-04-14T13:05:33.230Z (7 months ago)
- Topics: dev-proxy, express, express-middleware, nodejs, one-app, proxy-requests
- Language: JavaScript
- Homepage:
- Size: 1.37 MB
- Stars: 6
- Watchers: 18
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[One App is now InnerSource](https://github.com/americanexpress/one-app/issues/1393)
[](https://www.npmjs.com/package/@americanexpress/one-app-dev-proxy)
> Proxy requests to remote servers locally while also allowing for an [express](https://expressjs.com) middleware to be provided and applied to all requests.
## 📖 Table of Contents
* [Features](#-features)
* [Usage](#-usage)
* [API](#-api)
* [contributing](#-contributing)
## ✨ Features
* Proxy requests to remote servers locally.
* Add an [express](https://expressjs.com) middleware applied to all requests.
## 🤹 Usage
### Installation
```bash
npm i @americanexpress/one-app-dev-proxy -D
```
Look at the different `options` you can use under the [API](#API) section.
```js
import oneAppDevProxy from '@americanexpress/one-app-dev-proxy';
oneAppDevProxy({
useMiddleware: true,
pathToMiddleware: path.join(__dirname, '../../.dev/middleware'),
remotes: { api: 'https://api.com' },
});
```
## 🎛️ API
## oneAppDevProxy( [options] )
### options
Type: `object`
provide the options below to start the mock services.
#### useMiddleware
Type: `boolean`
Default: `false`
provides the option of whether to apply provided middleware to `one-app-dev-proxy` server.
#### pathToMiddleware
Type: `string`
path to a file exporting an express middleware function by the HTTP_PROXY environment variable.
#### remotes
Type: `object`
Default: `{}`
Configuration object containing paths `one-app-dev-proxy` should serve and where requests coming to those paths should be proxied to. Used if `pathToMiddleware` is not provided.
**Note**: one-app-dev-proxy respects the `HTTP_PROXY` / `http_proxy`, `HTTPS_PROXY` / `https_proxy`,
and `NO_PROXY` / `no_proxy` environment variables and will use those accordingly when making
requests to remotes provided in the `remotes` option.
## 🏆 Contributing
We welcome Your interest in the American Express Open Source Community on Github.
Any Contributor to any Open Source Project managed by the American Express Open
Source Community must accept and sign an Agreement indicating agreement to the
terms below. Except for the rights granted in this Agreement to American Express
and to recipients of software distributed by American Express, You reserve all
right, title, and interest, if any, in and to Your Contributions. Please [fill
out the Agreement](https://cla-assistant.io/americanexpress/one-app-dev-proxy).
Please feel free to open pull requests and see [CONTRIBUTING.md](./CONTRIBUTING.md) to learn how to get started contributing.
## 🗝️ License
Any contributions made under this project will be governed by the [Apache License
2.0](https://github.com/americanexpress/one-app-dev-proxy/blob/main/LICENSE.txt).
## 🗣️ Code of Conduct
This project adheres to the [American Express Community Guidelines](./CODE_OF_CONDUCT.md).
By participating, you are expected to honor these guidelines.