Merge pull request #2 from swift-server-community/sebsto/openapi

initial commit for openapi example

Author: MarwaneKoutar

.gitignore

@@ -1,3 +1,4 @@
 __pycache__/
 *.__pyc
 .DS_Store
+.build

cookiecutter.json

@@ -19,6 +19,11 @@
       "path": "templates/scheduler-to-lambda",
       "title": "Scheduler to Lambda",
       "description": "Scheduled events to Lambda function integration"
-    }
+    },
+    "openapi-to-lambda": {
+      "path": "templates/openapi-to-lambda",
+      "title": "OpenAPI definition to Lambda",
+      "description": "An OpenAPI definition to generate the Lambda function (with API Gateway)"
+    }    
   }
 }

templates/openapi-to-lambda/cookiecutter.json

@@ -0,0 +1,15 @@
+{
+  "project_name": "StockQuote OpenApi to Swift Lambda",
+  "__project_name": "{{ cookiecutter.project_name|lower|replace(' ', '-') }}",
+  "__architecture": "{{ 'x86_64'|architecture }}",
+  "_copy_without_render": [".gitignore"],
+  "_template_name": "OpenApi to Lambda",
+  "_runtime": "Swift 5.10.0",
+  "_swift_tools_version": "5.10.0",
+  "_aws_swift_sdk_version": "0.45.0",
+  "__project_dir": "{{ 'Change this path'|get_abs_path }}/{{ cookiecutter.__project_name }}",
+  "_extensions": [
+    "local_extensions.architecture",
+    "local_extensions.get_abs_path"
+  ]
+}

templates/openapi-to-lambda/doc/INFO.md

@@ -0,0 +1,45 @@
+# OpenAPI to Lambda SAM template
+
+This templates allows developers to start with an OpenAPI definition of the REST service they want to create.
+
+The swift OpenAPI generator plugin generates data types and server stubs at each `swift build` command. This ensures your Swift code stays in sync with your OpenAPI definition.
+
+When deploying this project on your AWS account, it created an Amazon API Gateway configured as pass-through. The API Gateway forwards all API calls to your Lambda function.
+
+## How to use this template?
+
+First, clone the template.
+
+```sh 
+sam init \
+     --location https://github.com/swift-server-community/aws-lambda-swift-sam-template/tree/main/templates/openapi-to-lambda \
+     --no-interactive  \
+     --no-input        \
+		 --name <your project name> 
+```
+
+## Testing a template locally 
+
+Testing a template locally
+You can create a buildable and deployable project folder from a local template using the below command. The `<project_name>` can be whatever you want your project to be called, and `<path/to/init_template>` should point to the existing folder that contains the template.
+
+Command:
+
+```sh
+sam init --location <path/to/init_template>  \
+         --no-input \
+				 --name <project_name>    
+```
+
+For example:
+
+```sh
+sam init \
+       --location /Users/myuser/code/aws-lambda-swift-sam-template/openapi-t-lambda \
+			 --name StockQuoteApi
+```
+
+## Learn more
+
+- [Swift OpenAPI Generator](https://github.com/apple/swift-openapi-generator)
+- [Swift OpenAPI Transport for AWS Lambda](https://github.com/swift-server/swift-openapi-lambda)

templates/openapi-to-lambda/doc/dark.webp

@@ -0,0 +1,33 @@
+#===----------------------------------------------------------------------===//
+#
+# This source file is part of the AWS Lambda Swift 
+# VSCode extension open source project.
+#
+# Copyright (c) 2024, the VSCode AWS Lambda Swift extension project authors.
+# Licensed under Apache License v2.0.
+#
+# See LICENSE.txt for license information
+# See CONTRIBUTORS.txt for the list of VSCode AWS Lambda Swift project authors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+#===----------------------------------------------------------------------===//
+
+import platform
+import os
+from cookiecutter.utils import simple_filter
+
+@simple_filter
+def architecture(v):
+    arch = platform.machine().lower()
+    if 'aarch' in arch or 'arm' in arch:
+        return 'arm64'
+    else:
+        return v
+    
+@simple_filter
+def get_abs_path(v):
+    if os.getcwd():
+        return os.getcwd()
+    else:
+        return v

templates/openapi-to-lambda/doc/illustrations.pptx

@@ -0,0 +1,10 @@
+.DS_Store
+.aws-sam/
+*/build/*
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

templates/openapi-to-lambda/doc/light.webp

@@ -0,0 +1,18 @@
+#===----------------------------------------------------------------------===//
+#
+# This source file is part of the AWS Lambda Swift 
+# VSCode extension open source project.
+#
+# Copyright (c) 2024, the VSCode AWS Lambda Swift extension project authors.
+# Licensed under Apache License v2.0.
+#
+# See LICENSE.txt for license information
+# See CONTRIBUTORS.txt for the list of VSCode AWS Lambda Swift project authors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+#===----------------------------------------------------------------------===//
+
+FROM swift:amazonlinux2
+
+RUN yum -y install openssl-devel