You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@openwhisk.apache.org by GitBox <gi...@apache.org> on 2018/03/28 18:57:05 UTC
[GitHub] mrutkows closed pull request #829: Added documentation and example for API Gateway hello world
mrutkows closed pull request #829: Added documentation and example for API Gateway hello world
URL: https://github.com/apache/incubator-openwhisk-wskdeploy/pull/829
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/examples/manifest_hello_world_apigateway.yaml b/docs/examples/manifest_hello_world_apigateway.yaml
new file mode 100644
index 00000000..208a6e06
--- /dev/null
+++ b/docs/examples/manifest_hello_world_apigateway.yaml
@@ -0,0 +1,30 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with this work for additional
+# information regarding copyright ownership. The ASF licenses this file to you
+# 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.
+#
+
+# Example: Basic Hello World action with API
+packages:
+ hello_world_package:
+ version: 1.0
+ license: Apache-2.0
+ actions:
+ hello_world:
+ function: src/hello.js
+ web-export: true
+ apis:
+ hello-world:
+ hello:
+ world:
+ hello_world: GET
diff --git a/docs/examples/wskdeploy_apigateway_helloworld.md b/docs/examples/wskdeploy_apigateway_helloworld.md
new file mode 100644
index 00000000..570e08dd
--- /dev/null
+++ b/docs/examples/wskdeploy_apigateway_helloworld.md
@@ -0,0 +1,118 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with this work for additional
+# information regarding copyright ownership. The ASF licenses this file to you
+# 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.
+#
+-->
+
+# API Gateway
+
+## The "Hello World" API
+
+This example builds on the ["Hello World" Action](wskdeploy_action_helloworld.md#actions) example by adding an API definition on top of that action so that I can be queried via an HTTP call.
+
+It shows how to:
+- update the Action named ‘hello_world’ to expose it to the gateway.
+- specify the API's endpoint that will trigger the action.
+
+### Manifest file
+#### _Example: “Hello world” action with API_
+```yaml
+packages:
+ hello_world_package:
+ version: 1.0
+ license: Apache-2.0
+ actions:
+ hello_world:
+ function: src/hello.js
+ web-export: true
+ apis:
+ hello-world:
+ hello:
+ world:
+ hello_world: GET
+```
+
+There are two key changes to this file:
+- the `hello_world` action now has the `web-export` flag set to `true`.
+- a new `apis` block has been created.
+
+The `apis` block contains a number of groups of API endpoint. Each endpoint is then defined by the hierarchy. In this case, we are creating the `hello/world` endpoint. The leaf in the structure specifies the action to trigger when the given HTTP verb is sent to that endpoint, in this case, when the HTTP verb `GET` is used on the `hello/world` endpoint, trigger the `hello_world` action.
+
+### Deploying
+
+You can actually deploy the "hello world API gateway" manifest from the incubator-openwhisk-wskdeploy project directory if you have downloaded it from GitHub:
+
+```sh
+$ wskdeploy -m docs/examples/manifest_hello_world_apigateway.yaml
+```
+
+### Invoking
+
+Check the full URL of your API first:
+```sh
+$ wsk api list
+```
+
+This will return some information on the API, including the full URL, which
+should end with `hello/world`. It can then be invoked:
+
+```sh
+$ curl <url>
+```
+
+### Result
+The invocation should return a JSON response that includes this result:
+
+```json
+{
+ "greeting": "Hello, undefined from undefined"
+}
+```
+
+The output parameter '```greeting```' contains "_undefined_" values for the '```name```' and '```place```' input parameters as they were not provided in the manifest or the HTTP call. You can provide them as query parameters:
+
+```sh
+$ curl <url>?name=World&place=Earth
+```
+
+### Discussion
+
+This "hello world" example represents the minimum valid Manifest file which includes only the required parts of the Package, Action and API descriptors.
+
+### Source code
+The source code for the manifest and JavaScript files can be found here:
+- [manifest_hello_world_apigateway.yaml](examples/manifest_hello_world_apigateway.yaml)
+- [hello.js](examples/src/hello.js)
+
+### Specification
+For convenience, the Packages and Actions grammar can be found here:
+- **[Packages](../specification/html/spec_packages.md#packages)**
+- **[Actions](../specification/html/spec_actions.md#actions)**
+
+---
+<!--
+ Bottom Navigation
+-->
+<html>
+<div align="center">
+<table align="center">
+ <tr>
+ <td><a href="wskdeploy_triggerrule_trigger_bindings.md#triggers-and-rules"><< previous</a></td>
+ <td><a href="programming_guide.md#guided-examples">Example Index</a></td>
+ <!--<td><a href="">next >></a></td>-->
+ </tr>
+</table>
+</div>
+</html>
diff --git a/docs/programming_guide.md b/docs/programming_guide.md
index 1c92b928..ed562566 100644
--- a/docs/programming_guide.md
+++ b/docs/programming_guide.md
@@ -54,6 +54,8 @@ Each example shows the "code", that is the Package Manifest, Deployment file and
- Trigger and Rule examples
- [Basic Trigger and Rule](wskdeploy_triggerrule_basic.md#triggers-and-rules) - adding a basic trigger and rule to the advanced Parameter "hello world".
- [Binding parameters in a Deployment file](wskdeploy_triggerrule_trigger_bindings.md#triggers-and-rules) - using a deployment file to bind values to a Trigger’s parameters and applying them to a compatible manifest file.
+- API Gateway examples
+ - [The "Hello World" API Gateway](wskdeploy_apigateway_helloworld.md#api-gateway) - deploy a "hello world" JavaScript function with associated HTTP API.
---
<!--
diff --git a/docs/wskdeploy_triggerrule_trigger_bindings.md b/docs/wskdeploy_triggerrule_trigger_bindings.md
index 39eba095..ab51cce9 100644
--- a/docs/wskdeploy_triggerrule_trigger_bindings.md
+++ b/docs/wskdeploy_triggerrule_trigger_bindings.md
@@ -130,7 +130,7 @@ For convenience, the Actions and Parameters grammar can be found here:
<tr>
<td><a href="wskdeploy_triggerrule_basic.md#triggers-and-rules"><< previous</a></td>
<td><a href="programming_guide.md#guided-examples">Example Index</a></td>
-<!-- <td><a href="">next >></a></td> -->
+ <td><a href="wskdeploy_apigateway_helloworld.md#packages">next >></a></td>
</tr>
</table>
</div>
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services