Browse Source

Merge branch 'master' into redhat

pull/23/head
Andrea Tarocchi 7 years ago
parent
commit
c62fed1b79
  1. 13
      README.adoc
  2. 23
      src/main/resources/META-INF/resources/rest-http-index.html

13
README.adoc

@ -3,18 +3,15 @@
= REST API Level 0 - Fuse Booster
== Overview
The REST API Level 0 mission shows how to map business operations to a remote procedure call endpoint over HTTP by using a REST framework. This mission corresponds to Level 0 in the Richardson Maturity Model.
By using this Fuse booster, you can implement this mission by quickly prototyping and flexibly designing your REST API.
By using this Fuse booster, you can quickly prototype and flexibly design a REST API.
This booster introduces the mechanics of interacting with a remote (exposed by Apache Camel) service using the HTTP protocol.
Use this booster to:
* Execute an HTTP GET request on the `camel/greetings/{name}` endpoint by using the URL parameter `{name}`
* Produce a response in JSON format with a payload of `Hello, $name!` (where `$name` is replaced by the value of the URL parameter from the HTTP GET request).
* Execute an HTTP GET request on the `camel/greetings/{name}` endpoint by using the URL parameter `{name}`. The JSON-formatted response has a payload of `Hello, $name!` (where `$name` is replaced by the value of the URL parameter from the HTTP GET request).
* Browse the API's Swagger page.
@ -57,11 +54,11 @@ $ oc login -u developer -p developer
$ oc new-project MY_PROJECT_NAME
----
. Change the directory to the folder that contains the extracted booster application (for example, `my_openshift/fuse-rest-http-booster-master`) :
. Change the directory to the folder that contains the extracted booster application (for example, `my_openshift/fuse-rest-http-booster`) :
+
[source,bash,options="nowrap",subs="attributes+"]
----
$ cd my_openshift/fuse-rest-http-booster-master
$ cd my_openshift/fuse-rest-http-booster
----
. Build and deploy the project to the OpenShift cluster:
@ -77,7 +74,7 @@ Wait until you can see that the pod for the `fuse-rest-http-booster` application
. On the project's `Overview` page, locate the URL for the `fuse-rest-http-booster` application. The URL uses this form:
`http://fuse-rest-http-booster-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io`.
. Click the URL to access the greetings service application and then follow the instructions on that page.
. Click the URL to access the Greeting Service and then follow the instructions on that page.
[#single-node-without-preinstalled-images]
=== Running the booster on a single-node OpenShift cluster without preinstalled images

23
src/main/resources/META-INF/resources/rest-http-index.html

@ -11,28 +11,27 @@
<body>
<div class="container">
<div>
<h1>REST HTTP - Red Hat Fuse</h1>
<h1>REST API Level 0 - Red Hat Fuse</h1>
<p class="lead">
The REST API Level 0 mission demonstrates how to map business operations to a remote procedure call endpoint over HTTP using a REST framework. This mission corresponds to Level 0 in the Richardson Maturity Model.
</p>
<p class="lead">
By using this Fuse booster, you can implement this mission to quickly prototype and flexibly design your REST API.
The REST API Level 0 booster demonstrates how to map business operations to a remote procedure call endpoint over HTTP using a REST framework. This mission corresponds to Level 0 in the Richardson Maturity Model.
</p>
<p class="lead">
This booster introduces the mechanics of interacting with a remote (exposed by Apache Camel) service using the HTTP protocol.
</p>
<p class="lead">
Use this booster to:
By using this Fuse booster, you can quickly prototype and flexibly design your REST API.
</p>
<p class="lead">
To demonstrate the behavior of this booster:
<ul class="lead">
<li>Execute an HTTP GET request on the <code>camel/greetings/{name}</code> endpoint:
<a class="btn btn-info" href="/camel/greetings/Jacopo" target="_blank">camel/greetings/{name}</a> </li>
<li>Produce a response in JSON format with a payload of <code>Hello, $name!</code>
where <code>$name</code> is replaced by the value of the <code>{name}</code> URL parameter from the HTTP GET request.</li>
<li>Browse the REST API's Swagger page: <a class="btn btn-info" href="/webjars/swagger-ui/index.html?url=/camel/api-doc&validatorUrl=" target="_blank">API Swagger page</a></li>
<li>Click <a class="btn btn-info" href="/camel/greetings/Jacopo" target="_blank">camel/greetings/{name}</a> to execute an HTTP GET request on the <code>camel/greetings/{name}</code> endpoint.
<p>A new browser window opens and shows a response in JSON format with a payload of <code>Hello, $name!</code>
where <code>$name</code> is the value of the <code>{name}</code> URL parameter from the HTTP GET request. By default, this is <b>Jacopo</b>.</li>
<li>Change the name in the URL from <b>Jacopo</b> to your name. Observe that the response reflects the name change.</li>
</ul>
</p>
<p class="lead">Click <a class="btn btn-info" href="/webjars/swagger-ui/index.html?url=/camel/api-doc&validatorUrl=" target="_blank">API Swagger page</a> to open the REST API's Swagger page.</p>
</div>
</div>
</body>

Loading…
Cancel
Save