Browse Source

Update index.html file

Doc review
pull/23/head
MelissaFlinn 7 years ago committed by Andrea Tarocchi
parent
commit
96d0b65fd9
  1. 23
      src/main/resources/META-INF/resources/rest-http-index.html

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