diff --git a/README.adoc b/README.adoc index 6a6adab..fa8dc10 100644 --- a/README.adoc +++ b/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 diff --git a/src/main/resources/META-INF/resources/rest-http-index.html b/src/main/resources/META-INF/resources/rest-http-index.html index 37395eb..366a5fc 100644 --- a/src/main/resources/META-INF/resources/rest-http-index.html +++ b/src/main/resources/META-INF/resources/rest-http-index.html @@ -11,28 +11,27 @@
-

REST HTTP - Red Hat Fuse

+

REST API Level 0 - Red Hat Fuse

- 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. -

-

- 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.

This booster introduces the mechanics of interacting with a remote (exposed by Apache Camel) service using the HTTP protocol.

- Use this booster to: + By using this Fuse booster, you can quickly prototype and flexibly design your REST API. +

+

+ To demonstrate the behavior of this booster:

+

Click API Swagger page to open the REST API's Swagger page.