serverless-documentation-example/serverless.yml at master · oyvinyg/serverless-documentation-example · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
service: serverless-rest-api-with-dynamodb

frameworkVersion: ">=1.1.0 <2.0.0"

provider:
  name: aws
  runtime: nodejs8.10
  environment:
    DYNAMODB_TABLE: ${self:service}-${opt:stage, self:provider.stage}
  iamRoleStatements:
    - Effect: Allow
      Action:
        - dynamodb:Query
        - dynamodb:Scan
        - dynamodb:GetItem
        - dynamodb:PutItem
        - dynamodb:UpdateItem
        - dynamodb:DeleteItem
      Resource: "arn:aws:dynamodb:${opt:region, self:provider.region}:*:table/${self:provider.environment.DYNAMODB_TABLE}"
  region: eu-west-1

functions:
  create:
    handler: todos/create.create
    events:
      - http:
          path: todos
          method: post
          cors: true
          documentation: ${file(documentation/create.yaml)}
  list:
    handler: todos/list.list
    events:
      - http:
          path: todos
          method: get
          cors: true
          documentation: ${file(documentation/list.yaml)}

  get:
    handler: todos/get.get
    events:
      - http:
          path: todos/{id}
          method: get
          cors: true
          documentation: ${file(documentation/get.yaml)}

  update:
    handler: todos/update.update
    events:
      - http:
          path: todos/{id}
          method: put
          cors: true
          documentation: ${file(documentation/update.yaml)}

  delete:
    handler: todos/delete.delete
    events:
      - http:
          path: todos/{id}
          method: delete
          cors: true
          documentation: ${file(documentation/delete.yaml)}

resources:
  Resources:
    TodosDynamoDbTable:
      Type: 'AWS::DynamoDB::Table'
      DeletionPolicy: Retain
      Properties:
        AttributeDefinitions:
          -
            AttributeName: id
            AttributeType: S
        KeySchema:
          -
            AttributeName: id
            KeyType: HASH
        ProvisionedThroughput:
          ReadCapacityUnits: 1
          WriteCapacityUnits: 1
        TableName: ${self:provider.environment.DYNAMODB_TABLE}

custom:
  documentation:
    version: '6'
    summary: 'Todo API'
    description: 'A todo API documented with OpenAPI specification'
    resources:
      -
        path: "todos"
        description: "Path used for creating and listing todos"
      -
        path: "todos/{id}"
        description: "Path used for getting, updating, and deleting todos"
    models:
      -
        name: "todo"
        description: "a todo object"
        contentType: "application/json"
        schema:
          type: object
          properties:
            id:
              type: string
              format: uuid
            text:
              type: string
              format: string
            checked:
              type: boolean
            createdAt:
              type: number
            updatedAt:
              type: number
          required:
            - id
            - checked
            - text
            - createdAt
            - updatedAt
      -
        name: "todoCreateRequest"
        description: "a todo create request model"
        contentType: "application/json"
        schema:
          type: object
          properties:
            text:
              type: string
              format: string
          required:
            - text
      -
        name: "todoUpdateRequest"
        description: "a todo update request model"
        contentType: "application/json"
        schema:
          type: object
          properties:
            text:
              type: string
              format: string
            checked:
              type: boolean
          required:
            - text
            - checked
      -
        name: "todoList"
        description: "a list of todo objects"
        contentType: "application/json"
        schema:
          type: array
          items:
            $ref: "{{model: todo}}"
      -
          name: "awsError"
          description: "an aws internal server error, usually with status code 502 (bad gateway)"
          contentType: "application/json"
          schema:
            type: object
            properties:
              message:
                type: string
            required:
              - message

plugins:
  - serverless-aws-documentation