浏览代码

Added README.md

Fixing-CORS-crash
BinHong Lee 7 年前
父节点
当前提交
11d2a817df
共有 1 个文件被更改,包括 56 次插入0 次删除
  1. +56
    -0
      README.md

+ 56
- 0
README.md 查看文件

@@ -0,0 +1,56 @@
# Breakups

Creating a payment chain for bill splitting needs

api domain: `https:\\breakups.herokuapp.com\`

## API Call Documentations

| Type | Call | Request | Response |
|:-----|:-----|:--------|:---------|
| `GET` | `help` | - | URL to github repository |
| `POST` | `total` | [standard format](#standard-format) | `{ "total": 200 }` |
| `POST` | `perPerson` | [standard format](#standard-format) | `{ "perPerson": 30 }` |
| `POST` | `oweChart` | [standard format](#standard-format) | [standard format](#standard-format) |
| `POST` | `sortedOweChart` | [standard format](#standard-format) | [standard format](#standard-format) |
| `POST` | `paymentChain` | [standard format](#standard-format) | [chain format](#chain-format) |

## Expected Request / Response

### standard format

```JSON
{
"users": [
{
"name": "Person1",
"amount": 100
},
{
"name": "Person2",
"amount": 50
},
{
"name": "Person3",
"amount": 30
}
]
}
```

### chain format

```JSON
[
{
"from": "Person2",
"to": "Person3",
"amount": 10
},
{
"from": "Person3",
"to": "Person1",
"amount": 40
}
]
```

正在加载...
取消
保存