From 9d813e893b15365dd13e645e0f0ea3293c21fcf8 Mon Sep 17 00:00:00 2001 From: Chris Spitzenberger Date: Tue, 11 Aug 2020 18:22:24 -0500 Subject: [PATCH 1/2] Added example for openapi inline DocumentBody using the Python3 example to incorporate a lambda. --- python/api-gateway-openapi/lambda_function.py | 12 ++ python/api-gateway-openapi/license.txt | 201 ++++++++++++++++++ python/api-gateway-openapi/requirements.txt | 0 python/api-gateway-openapi/spec.json | 26 +++ python/api-gateway-openapi/template.yaml | 61 ++++++ python/api-gateway-openapi/testEvent.json | 6 + 6 files changed, 306 insertions(+) create mode 100644 python/api-gateway-openapi/lambda_function.py create mode 100755 python/api-gateway-openapi/license.txt create mode 100644 python/api-gateway-openapi/requirements.txt create mode 100644 python/api-gateway-openapi/spec.json create mode 100644 python/api-gateway-openapi/template.yaml create mode 100644 python/api-gateway-openapi/testEvent.json diff --git a/python/api-gateway-openapi/lambda_function.py b/python/api-gateway-openapi/lambda_function.py new file mode 100644 index 0000000..7a90653 --- /dev/null +++ b/python/api-gateway-openapi/lambda_function.py @@ -0,0 +1,12 @@ +import json + +print('Loading function') + + +def lambda_handler(event, context): + #print("Received event: " + json.dumps(event, indent=2)) + print("value1 = " + event['key1']) + print("value2 = " + event['key2']) + print("value3 = " + event['key3']) + return event['key1'] # Echo back the first key value + #raise Exception('Something went wrong') diff --git a/python/api-gateway-openapi/license.txt b/python/api-gateway-openapi/license.txt new file mode 100755 index 0000000..e987a55 --- /dev/null +++ b/python/api-gateway-openapi/license.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2017 LogicMonitor + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/python/api-gateway-openapi/requirements.txt b/python/api-gateway-openapi/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/python/api-gateway-openapi/spec.json b/python/api-gateway-openapi/spec.json new file mode 100644 index 0000000..5411334 --- /dev/null +++ b/python/api-gateway-openapi/spec.json @@ -0,0 +1,26 @@ +{ + "openapi" : "3.0.1", + "info" : { + "title" : "Pets", + "version" : "2020-07-31 18:56:01UTC" + }, + "paths" : { + "/petstore/pets" : { + "get" : { + "responses" : { + "default" : { + "description" : "Default response for GET /petstore/pets" + } + }, + "x-amazon-apigateway-integration" : { + "payloadFormatVersion" : "1.0", + "type" : "http_proxy", + "httpMethod" : "GET", + "uri" : "http://petstore-demo-endpoint.execute-api.com/petstore/pets", + "connectionType" : "INTERNET" + } + } + } + }, + "x-amazon-apigateway-importexport-version" : "1.0" +} \ No newline at end of file diff --git a/python/api-gateway-openapi/template.yaml b/python/api-gateway-openapi/template.yaml new file mode 100644 index 0000000..83955e7 --- /dev/null +++ b/python/api-gateway-openapi/template.yaml @@ -0,0 +1,61 @@ +AWSTemplateFormatVersion: '2010-09-09' +Transform: AWS::Serverless-2016-10-31 +Description: A bare bones example of deploying an API Gateway API with one Lambda using an OpenAPI 3.0.1 example spec file as in-line yaml. +Parameters: + Name: + Type: String + Description: The name of the API to create, also used as the stack name. + Version: + Type: String + Description: The version of the API. This value is also used as the API StageName. + AllowedPattern: "[a-zA-Z][a-zA-Z0-9]*" + IdentityNameParameter: + Type: String +Resources: + Api: + Type: AWS::Serverless::Api + Properties: + Name: !Ref Name + StageName: !Ref Version + OpenApiVersion: 3.0.1 + DefinitionBody: + openapi: 3.0.1 + info: + title: Hello World API + description: This is a swagger example. + contact: + email: you@your-company.com + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + version: 1.0.0 + paths: + /hello/world: + get: + summary: get hello world + description: | + Invokes hello world lambda function example. + responses: + "200": + description: search results matching criteria + "400": + description: bad input parameter + x-amazon-apigateway-integration: + uri: + Fn::Sub: arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${HelloWorldPython3.Arn}/invocations + responses: + default: + statusCode: "200" + passthroughBehavior: when_no_match + httpMethod: POST + contentHandling: CONVERT_TO_TEXT + type: aws_proxy + HelloWorldPython3: + Type: 'AWS::Serverless::Function' + Properties: + Handler: lambda_function.lambda_handler + Runtime: python3.8 + CodeUri: . + Description: A starter AWS Lambda function. + MemorySize: 128 + Timeout: 3 \ No newline at end of file diff --git a/python/api-gateway-openapi/testEvent.json b/python/api-gateway-openapi/testEvent.json new file mode 100644 index 0000000..caa14b6 --- /dev/null +++ b/python/api-gateway-openapi/testEvent.json @@ -0,0 +1,6 @@ +{ + "key1": "value1", + "key2": "value2", + "key3": "value3" + } + \ No newline at end of file From e4f7aab63330d902ef1132ed9fb85eaed37877e4 Mon Sep 17 00:00:00 2001 From: Chris Spitzenberger Date: Fri, 14 Aug 2020 14:41:08 -0500 Subject: [PATCH 2/2] removed the external spec.json file --- python/api-gateway-openapi/spec.json | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100644 python/api-gateway-openapi/spec.json diff --git a/python/api-gateway-openapi/spec.json b/python/api-gateway-openapi/spec.json deleted file mode 100644 index 5411334..0000000 --- a/python/api-gateway-openapi/spec.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "openapi" : "3.0.1", - "info" : { - "title" : "Pets", - "version" : "2020-07-31 18:56:01UTC" - }, - "paths" : { - "/petstore/pets" : { - "get" : { - "responses" : { - "default" : { - "description" : "Default response for GET /petstore/pets" - } - }, - "x-amazon-apigateway-integration" : { - "payloadFormatVersion" : "1.0", - "type" : "http_proxy", - "httpMethod" : "GET", - "uri" : "http://petstore-demo-endpoint.execute-api.com/petstore/pets", - "connectionType" : "INTERNET" - } - } - } - }, - "x-amazon-apigateway-importexport-version" : "1.0" -} \ No newline at end of file