Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devem-tech/echo
Powerful API emulation with reverse proxy and easy json configuration.
https://github.com/devem-tech/echo
Last synced: about 2 months ago
JSON representation
Powerful API emulation with reverse proxy and easy json configuration.
- Host: GitHub
- URL: https://github.com/devem-tech/echo
- Owner: devem-tech
- Created: 2023-01-18T00:07:07.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-15T00:54:50.000Z (3 months ago)
- Last Synced: 2024-03-15T02:12:15.501Z (3 months ago)
- Language: Go
- Homepage:
- Size: 26.4 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Lists
- awesome-cli-apps - echo - Speedy API emulation facilitated by a reverse proxy and mock JSON server. (<a name="networking"></a>Networking)
- cli-apps - echo - Speedy API emulation facilitated by a reverse proxy and mock JSON server. (<a name="networking"></a>Networking)
README
```
___ _
| __|__| |_ ___
| _|/ _| ' \/ _ \
|___\__|_||_\___/
```
---
[](https://goreportcard.com/report/github.com/devem-tech/echo)
**Echo** -- easy-to-use mock server that accelerates api emulation with json.
### Features
- simple json format
- response latency
- reverse proxy mode
- request and response logs
## How to use
### Create a mock file
The json format is as follows:
- **key** -- route
- **value** -- response
The **key** is a colon-separated string which contains 3 parts:
| # | Part | Required | Default |
|---|--------|:--------:|:-------:|
| 1 | Method | | GET |
| 2 | Code | | 200 |
| 3 | Path | * | |
#### Mapping example
| Key | Method | Path | Code |
|------------------|:------:|-----------|:----:|
| /orders | GET | /orders | 200 |
| 404:/orders/1 | GET | /orders/1 | 404 |
| GET:/orders/2 | GET | /orders/2 | 200 |
| POST:201:/orders | POST | /orders | 201 |
### Example
```json
{
"/v1/orders/1": {
"id": 1,
"status": "confirmed"
},
"POST:201:/v1/orders": {
"success": true
}
}
```
### Go
```bash
echo routes.json
```
```bash
Options:
--port PORT, -p PORT port [default: 8080]
--color, -c color output [default: true]
--latency LATENCY, -l LATENCY
response latency [default: 0]
--print PRINT string specifying what the output should contain:
'H' request headers
'B' request body
'h' response headers
'b' response body
--verbose, -v verbose output
--help, -h display this help and exit
--version display version and exit
```
### Testing
```bash
curl 127.0.0.1:8080/v1/orders/1
```
```bash
curl -X POST 127.0.0.1:8080/v1/orders
```
## Reverse proxy mode
Redirect all non-defined routes to the specified host:
```json
{
"*": "https://jsonplaceholder.typicode.com"
}
```
Override a specific route:
```json
{
"*": "https://jsonplaceholder.typicode.com",
"/todos/1": {
"id": 1,
"userId": 1,
"title": "default",
"completed": false
}
}
```