You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source-2.0/java/quickstart.rst
+16-7Lines changed: 16 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,8 @@
2
2
Java Quickstart
3
3
===============
4
4
5
-
This guide introduces `Smithy Java <https://github.com/smithy-lang/smithy-java>`_ with a simple working example of a generated server and client.
5
+
This guide introduces `Smithy Java <https://github.com/smithy-lang/smithy-java>`_ with a simple working example of a
6
+
generated server and client.
6
7
7
8
For this example, imagine that you are the proud owner of a coffee shop.
8
9
Your API allows your customers to order some *java* from their Java applications.
@@ -11,19 +12,24 @@ Users can use your SDK to list available coffees, order a coffee, and track the
11
12
.. admonition:: Review
12
13
:class: tip
13
14
14
-
If you are new to Smithy or just need a refresher on the basics, you may find it helpful to work through the Smithy :doc:`../quickstart`.
15
+
If you are new to Smithy or just need a refresher on the basics, you may find it helpful to work through the
16
+
Smithy :doc:`../quickstart`.
15
17
16
18
-------------
17
19
Prerequisites
18
20
-------------
19
21
20
-
* Ensure you have `JDK 17 <https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html>`_ or higher installed. Older Java versions are not supported by Smithy Java.
21
-
* Ensure you have the the Smithy CLI installed. Run ``smithy --version`` to confirm the CLI is correctly installed. If you need to install the CLI, see :doc:`Smithy CLI Installation <../guides/smithy-cli/cli_installation>`.
22
+
* Ensure you have `JDK 17 <https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html>`_ or higher
23
+
installed. Older Java versions are not supported by Smithy Java.
24
+
* Ensure you have the the Smithy CLI installed. Run ``smithy --version`` to confirm the CLI is correctly installed.
25
+
If you need to install the CLI, see :doc:`Smithy CLI Installation <../guides/smithy-cli/cli_installation>`.
22
26
23
27
------
24
28
Set Up
25
29
------
26
-
Clone the quickstart example template using the Smithy CLI ``init`` command and change to the cloned directory:
30
+
31
+
Clone the `quickstart example template <https://github.com/smithy-lang/smithy-examples/tree/main/smithy-java-examples/quickstart-java>`_
32
+
using the Smithy CLI ``init`` command and change to the cloned directory:
27
33
28
34
.. code-block:: sh
29
35
@@ -59,7 +65,8 @@ From the root of the example project, build the project using Gradle:
59
65
Service Model
60
66
-------------
61
67
62
-
The Smithy API model for our service can be found in the model package. This model defines the interface of our service and guides the generation of client and server code.
68
+
The Smithy API model for our service can be found in the model package. This model defines the interface of our service and
69
+
guides the generation of client and server code.
63
70
64
71
The service provides a few capabilities:
65
72
@@ -80,7 +87,9 @@ The service has the ``@restJson1`` protocol trait applied indicating that the se
80
87
...
81
88
}
82
89
83
-
Protocols define the rules and conventions for serializing and de-serializing data when communicating between client and server.
90
+
Protocols define the rules and conventions for serializing and de-serializing data when communicating between
0 commit comments