Skip to content

Commit cefc1ef

Browse files
authored
Update README.md
1 parent d196b7d commit cefc1ef

File tree

1 file changed

+27
-4
lines changed

1 file changed

+27
-4
lines changed

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,36 @@
1-
# Serverless Apigateway Service proxy
2-
The Serverless Framewrok plugin to support AWS service proxy integration of API Gateway
1+
# Serverless Apigateway Service Proxy(BETA)
2+
The Serverless Framewrok plugin to support AWS service proxy integration of API Gateway. You can connect directly API Gateway with AWS services without Lambda. Currently, support only kinesis stream but will expend the other services.
3+
4+
## Install
5+
Run `npm install` in your Serverless project.
6+
7+
```
8+
$ npm install --save-dev serverless-apigateway-service-proxy
9+
```
10+
Add the plugin to your serverless.yml file
11+
12+
```yaml
13+
plugins:
14+
- serverless-apigateway-service-proxy
15+
```
316
417
## How to use
5-
Define something to setting of AWS services you want to integrate with under `custom > apiGatewayServiceProxy`
18+
Define something to setting of AWS services you want to integrate with under `custom > apiGatewayServiceProxy` and run `serverless deploy`.
619

720
### Kinesis
821
```yaml
922
custom:
1023
apiGatewayServiceProxy:
1124
- kinesis:
12-
path: /kinesis/{streamname}
25+
path: /kinesis
26+
method: post
27+
streamName: { Ref: 'YourStream' }
28+
cors: true
29+
30+
resources:
31+
Resources:
32+
YourStream:
33+
Type: AWS::Kinesis::Stream
34+
Properties:
35+
ShardCount: 1
1336
```

0 commit comments

Comments
 (0)