From d87c91d4121b7929cd0c6f84e894f20009bcabae Mon Sep 17 00:00:00 2001 From: MelissaFlinn <31925014+MelissaFlinn@users.noreply.github.com> Date: Thu, 9 Aug 2018 11:10:10 -0400 Subject: [PATCH] edit as requested https://issues.jboss.org/browse/FUSEDOC-2619 --- README.adoc | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/README.adoc b/README.adoc index 64f27c6..832c9e5 100644 --- a/README.adoc +++ b/README.adoc @@ -3,29 +3,33 @@ = 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 using a REST framework. This corresponds to Level 0 in the Richardson Maturity Model. -Creating an HTTP endpoint using REST and its underlying principles to define your API lets you quickly prototype and design the API flexibly. +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. -This booster introduces the mechanics of interacting with a remote (exposed by Apache Camel) service using the HTTP protocol. It allows you to: +By using this Fuse booster, you can implement this mission by quickly prototyping and flexibly designing your REST API. -* Execute an HTTP GET request on `camel/greetings/{name}`` endpoint; using the url parameter `{name}` and producing a response in JSON format with a payload of Hello, $name! with $name replaced by the value of the url parameter used into the request. -* Browse the api's Swagger page. +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). +* Browse the API's Swagger page. == Deployment options -This booster can run in the following modes: +You can run this booster in the following modes: * Standalone on your machine * Single-node OpenShift cluster * OpenShift Online at link:{launchURL}[] -The most effective way to demonstrate the booster is to deploy and run the project on OpenShift. +The most effective way to use this booster is to deploy and run the project on OpenShift. For more details about running this booster on a single-node OpenShift cluster, CI/CD deployments, as well as the rest of the runtime, see the link:http://appdev.openshift.io/docs/spring-boot-runtime.html[Spring Boot Runtime Guide]. -IMPORTANT: This booster requires Java 8 JDK or greater and Maven 3.3.x or greater. +IMPORTANT: This booster requires Java 8 JDK or later and Maven 3.3.x or later. == Running the booster standalone on your machine -You can run this booster as a standalone project on your local machine: +To run this booster as a standalone project on your local machine: . Download the project and extract the archive on your local filesystem. . Build the project: @@ -35,13 +39,13 @@ You can run this booster as a standalone project on your local machine: $ cd PROJECT_DIR $ mvn clean package ---- -. then run the services as follows: +. Run the services: + [source,bash,options="nowrap",subs="attributes+"] ---- $ mvn spring-boot:run ---- -. Visit link:http://localhost:8080[] and follow the instructions on that page. +. Go to link:http://localhost:8080[] and then follow the instructions on that page. == Running the booster on a single-node OpenShift cluster If you have a single-node OpenShift cluster, such as Minishift or the Red Hat Container Development Kit, link:http://appdev.openshift.io/docs/minishift-installation.html[installed and running], you can deploy your booster there. @@ -75,14 +79,15 @@ $ mvn clean -DskipTests fabric8:deploy -Popenshift . In your browser, navigate to the `MY_PROJECT_NAME` project in the OpenShift console. Wait until you can see that the pod for the `fuse-rest-http-booster` application has started up. -. Just above the entry for the `fuse-rest-http-booster` application on the `Overview` page, there is a URL of the form `http://fuse-rest-http-booster-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io`. -Click on the URL to access the greetings service application and follow the instructions on that page. +. Just above the entry for the `fuse-rest-http-booster` application on the `Overview` page, find the URL of the form `http://fuse-rest-http-booster-MY_PROJECT_NAME.OPENSHIFT_IP_ADDR.nip.io`. + +. Click on the URL to access the greetings service application and then follow the instructions on that page. == Running the booster on OpenShift Online You can deploy the circuit breaker booster directly to OpenShift Online when you create the project at link:{launchURL}[]. -. Visit link:{launchURL}[]. +. Go to link:{launchURL}[]. . At the *Deployment step*, select *Use OpenShift Online*. -. Follow the on-screen instructions to create a new *REST API Level 0* project using the *Fuse* runtime. +. Follow the on-screen instructions to create a new *REST API Level 0* project by using the *Fuse* runtime. -NOTE: As part of the process of creating this booster, link:{launchURL}[] sets up a project with a CI/CD deployment of this booster. You can see the status of this deployment in your Single-node OpenShift Cluster or OpenShift Online Web Console. +NOTE: As part of the process of creating this booster, link:{launchURL}[] sets up a project with a CI/CD deployment of this booster. You can see the status of this deployment in your single-node OpenShift cluster or OpenShift Online web console.