This is an automated email from the ASF dual-hosted git repository.
jamesbognar pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/juneau-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 042f5ea Petstore documentation.
042f5ea is described below
commit 042f5ea7d22b5814f37c95102ebb377dfe31b544
Author: JamesBognar <[email protected]>
AuthorDate: Tue Sep 10 09:18:34 2019 -0400
Petstore documentation.
---
content/petstore.html | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/content/petstore.html b/content/petstore.html
index 59bf57a..bd6a87a 100644
--- a/content/petstore.html
+++ b/content/petstore.html
@@ -36,7 +36,7 @@
by simply pulling in Maven dependencies. The server-side need
only provide the ability to host a servlet.
</p>
<p>
- The GitHub project hosting the application can be found <a
href='https://github.com/apache/juneau-petstore'>here</a>.
+ The GitHub project hosting the application can be found <a
class='doclink' href='https://github.com/apache/juneau-petstore'>here</a>.
</p>
<p>
The project is broken down into the following subprojects:
@@ -50,7 +50,7 @@
<p>
When the application is started up, you should see this page:
</p>
- <p class='bpcode w800'>
+ <p class='bcode w800'>
http://localhost:5000/petstore
</p>
<img class='bordered w800' src='petstore/1.png'>
@@ -58,7 +58,7 @@
<h3 class='topic'>juneau-petstore-api</h3>
<div class='topic'>
<p>
- The <o>juneau-petstore-api</o> module contains the Java
interface of our application and the DTOs that go along
+ The <c>juneau-petstore-api</c> module contains the Java
interface of our application and the DTOs that go along
with it. These classes are meant to be shared between
the server and client side code.
</p>
@@ -67,7 +67,7 @@
annotations used to describe how the methods map to
REST calls.
</p>
<h5 class='figure'>PetStore.java</h5>
- <p class='bpcode w800'>
+ <p class='bcode w800'>
<ja>@RemoteResource</ja>(path=<js>"/petstore"</js>)
<jk>public interface</jk> PetStore {
@@ -96,7 +96,7 @@
</p>
<p>
<ja>@RemoteResource</ja> and <ja>@RemoteMethod</ja> are
client-side annotations used to map the method calls to REST
- and will be describe in the
<c>juneau-petstore-client</c> section.
+ and will be describe in the client code section.
</p>
<p>
<ja>@Path</ja> and <ja>@Body</ja> are used by both the
client and server side code to map to REST artifacts on both
@@ -106,7 +106,7 @@
Both sets of annotations are provided by pulling in the
Juneau dependency below:
<h5 class='figure'>Maven Dependency</h5>
- <p class='bpcode w500'>
+ <p class='bpode w500'>
<xt><dependency></xt>
<xt><groupId></xt>org.apache.juneau<xt></groupId></xt>
<xt><artifactId></xt>juneau-marshall<xt></artifactId></xt>
@@ -118,7 +118,7 @@
so that they can easily be stored in a JPA datastore on
the server side.
</p>
<h5 class='figure'>Pet.java</h5>
- <p class='bpcode w800'>
+ <p class='bcode w800'>
<ja>@Bean</ja>(typeName=<js>"Pet"</js>, fluentSetters=<jk>true</jk>,
properties=<js>"id,species,name,tags,price,status"</js>)
<ja>@Entity</ja>(name=<js>"PetstorePet"</js>)
<jk>public class</jk> Pet {
@@ -158,7 +158,7 @@
</p>
<h5 class='figure'>Main.java</h5>
- <p class='bpcode w800'>
+ <p class='bcode w800'>
<jk>public class</jk> Main {
<jk>public static void</jk> main(String[] args) {
@@ -194,7 +194,7 @@
</p>
<h5 class='figure'>App.java</h5>
- <p class='bpcode w800'>
+ <p class='bcode w800'>
<ja>@SpringBootApplication</ja>
<jk>public class</jk> App {
@@ -211,7 +211,7 @@
</p>
<h5 class='figure'>AppConfiguration.java</h5>
- <p class='bpcode w800'>
+ <p class='bcode w800'>
<ja>@Configuration</ja>
<jk>public class</jk> AppConfiguration {
@@ -234,6 +234,7 @@
</p>
<p>
The <c>JuneauRestInitializer</c> is used to allow
Juneau resource classes to reference child Spring beans.
+ It is only required if you wish to use injection on
your child resources.
</p>
</div>
</div>
