Merge branch 'master' of github.com:avaje/avaje.github.io

avaje · Oct 27, 2023 · 436cb56 · 436cb56
2 parents d3a8c63 + 7a1d965
commit 436cb56
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 50 deletions.
diff --git a/http/index.html b/http/index.html
@@ -790,12 +790,12 @@ <h2 id="path-parameters">Path parameters</h2>
 </p>
 <div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// JAX-RS &quot;annotation noise&quot; with @PathParam</span>
 
-<span class="nd">@GET</span>
-<span class="nd">@Path</span><span class="o">(</span><span class="s">&quot;/{id}/{startDate}/{sort}&quot;</span><span class="o">)</span>
-<span class="nx">List</span><span class="o">&lt;</span><span class="nx">Bazz</span><span class="o">&gt;</span> <span class="nf">findBazz</span><span class="o">(</span><span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;id&quot;</span><span class="o">)</span> <span class="kt">long</span> <span class="nx">id</span><span class="o">,</span> <span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;startDate&quot;</span><span class="o">)</span> <span class="nx">LocalDate</span> <span class="nx">startDate</span><span class="o">,</span> <span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;sort&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">sort</span><span class="o">)</span> <span class="o">{</span>
+<span class="n">GET</span>
+<span class="nf">Path</span><span class="o">(</span><span class="s">&quot;/{id}/{startDate}/{sort}&quot;</span><span class="o">)</span>
+<span class="nx">ist</span><span class="o">&lt;</span><span class="nx">Bazz</span><span class="o">&gt;</span> <span class="nf">findBazz</span><span class="o">(</span><span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;id&quot;</span><span class="o">)</span> <span class="kt">long</span> <span class="nx">id</span><span class="o">,</span> <span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;startDate&quot;</span><span class="o">)</span> <span class="nx">LocalDate</span> <span class="nx">startDate</span><span class="o">,</span> <span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;sort&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">sort</span><span class="o">)</span> <span class="o">{</span>
 
-  <span class="c1">// we start getting &quot;annotation noise&quot; ...</span>
-  <span class="c1">// making the code hard to read</span>
+ <span class="c1">// we start getting &quot;annotation noise&quot; ...</span>
+ <span class="c1">// making the code hard to read</span>
 
 <span class="o">}</span>
 </pre></div>
@@ -853,13 +853,13 @@ <h4>JAX-RS @MatrixParam</h4>
 </p>
 <div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// JAX-RS &quot;annotation noise&quot; with @MatrixParam and @PathParam</span>
 
-<span class="nd">@GET</span>
-<span class="nd">@Path</span><span class="o">(</span><span class="s">&quot;/products/{type;category;vendor}/{range;style}&quot;</span><span class="o">)</span>
-<span class="nx">List</span><span class="o">&lt;</span><span class="nx">Product</span><span class="o">&gt;</span> <span class="nf">products</span><span class="o">(</span><span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;type&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">type</span><span class="o">,</span> <span class="nd">@MatrixParam</span><span class="o">(</span><span class="s">&quot;category&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">category</span><span class="o">,</span> <span class="nd">@MatrixParam</span><span class="o">(</span><span class="s">&quot;vendor&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">vendor</span><span class="o">,</span> <span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;type&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">range</span><span class="o">,</span> <span class="nd">@MatrixParam</span><span class="o">(</span><span class="s">&quot;style&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">style</span><span class="o">)</span> <span class="o">{</span>
+<span class="n">GET</span>
+<span class="nf">Path</span><span class="o">(</span><span class="s">&quot;/products/{type;category;vendor}/{range;style}&quot;</span><span class="o">)</span>
+<span class="nx">ist</span><span class="o">&lt;</span><span class="nx">Product</span><span class="o">&gt;</span> <span class="nf">products</span><span class="o">(</span><span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;type&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">type</span><span class="o">,</span> <span class="nd">@MatrixParam</span><span class="o">(</span><span class="s">&quot;category&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">category</span><span class="o">,</span> <span class="nd">@MatrixParam</span><span class="o">(</span><span class="s">&quot;vendor&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">vendor</span><span class="o">,</span> <span class="nd">@PathParam</span><span class="o">(</span><span class="s">&quot;type&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">range</span><span class="o">,</span> <span class="nd">@MatrixParam</span><span class="o">(</span><span class="s">&quot;style&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">style</span><span class="o">)</span> <span class="o">{</span>
 
-  <span class="c1">// we start getting &quot;annotation noise&quot; ...</span>
-  <span class="c1">// making the code hard to read</span>
-  <span class="o">...</span>
+ <span class="c1">// we start getting &quot;annotation noise&quot; ...</span>
+ <span class="c1">// making the code hard to read</span>
+ <span class="o">...</span>
 <span class="o">}</span>
 </pre></div>
 </div>
@@ -889,18 +889,18 @@ <h3>Implied query parameters</h3>
 </p>
 
 <div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Get</span><span class="o">(</span><span class="s">&quot;/{bornAfter}&quot;</span><span class="o">)</span>
-<span class="nx">List</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nx">LocalDate</span> <span class="nx">bornAfter</span><span class="o">,</span> <span class="nd">@QueryParam</span><span class="o">(</span><span class="s">&quot;orderBy&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">)</span> <span class="o">{</span>
-  <span class="o">...</span>
+<span class="nx">ist</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nx">LocalDate</span> <span class="nx">bornAfter</span><span class="o">,</span> <span class="nd">@QueryParam</span><span class="o">(</span><span class="s">&quot;orderBy&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">)</span> <span class="o">{</span>
+ <span class="o">...</span>
 <span class="o">}</span>
 
-<span class="nd">@Get</span><span class="o">(</span><span class="s">&quot;/{bornAfter}&quot;</span><span class="o">)</span>
-<span class="nx">List</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nx">LocalDate</span> <span class="nx">bornAfter</span><span class="o">,</span> <span class="nd">@QueryParam</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">)</span> <span class="o">{</span>
-  <span class="o">...</span>
+<span class="n">Get</span><span class="o">(</span><span class="s">&quot;/{bornAfter}&quot;</span><span class="o">)</span>
+<span class="nx">ist</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nx">LocalDate</span> <span class="nx">bornAfter</span><span class="o">,</span> <span class="nd">@QueryParam</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">)</span> <span class="o">{</span>
+ <span class="o">...</span>
 <span class="o">}</span>
 
-<span class="nd">@Get</span><span class="o">(</span><span class="s">&quot;/{bornAfter}&quot;</span><span class="o">)</span>
-<span class="n">List</span><span class="o">&lt;</span><span class="n">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="n">LocalDate</span> <span class="n">bornAfter</span><span class="o">,</span> <span class="n">String</span> <span class="n">orderBy</span><span class="o">)</span> <span class="o">{</span>  <span class="c1">// orderBy implied as query parameter</span>
-  <span class="o">...</span>
+<span class="n">Get</span><span class="o">(</span><span class="s">&quot;/{bornAfter}&quot;</span><span class="o">)</span>
+<span class="n">ist</span><span class="o">&lt;</span><span class="n">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="n">LocalDate</span> <span class="n">bornAfter</span><span class="o">,</span> <span class="n">String</span> <span class="n">orderBy</span><span class="o">)</span> <span class="o">{</span>  <span class="c1">// orderBy implied as query parameter</span>
+ <span class="o">...</span>
 <span class="o">}</span>
 </pre></div>
 </div>
@@ -917,11 +917,11 @@ <h4>Example</h4>
   hyphen like <code>order-by</code>.
 </p>
 <div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// order-by is not a valid java identifier</span>
-<span class="c1">// ... so we must use explicit @QueryParam here</span>
+<span class="o">/</span> <span class="o">...</span> <span class="nx">so</span> <span class="nx">we</span> <span class="nx">must</span> <span class="nx">use</span> <span class="nx">explicit</span> <span class="nd">@QueryParam</span> <span class="nx">here</span>
 
-<span class="nd">@Get</span>
-<span class="nx">List</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nd">@QueryParam</span><span class="o">(</span><span class="s">&quot;order-by&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">)</span> <span class="o">{</span>
-  <span class="o">...</span>
+<span class="n">Get</span>
+<span class="nx">ist</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nd">@QueryParam</span><span class="o">(</span><span class="s">&quot;order-by&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">)</span> <span class="o">{</span>
+ <span class="o">...</span>
 <span class="o">}</span>
 </pre></div>
 </div>
@@ -1344,8 +1344,8 @@ <h2 id="default">@Default</h3>
 </p>
 
 <div class="syntax java"><div class="highlight"><pre><span></span><span class="nd">@Get</span><span class="o">(</span><span class="s">&quot;/catty&quot;</span><span class="o">)</span>
-<span class="nx">List</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nd">@Header</span> <span class="nd">@Default</span><span class="o">(</span><span class="s">&quot;age&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">,</span> <span class="nd">@Default</span><span class="o">({</span><span class="s">&quot;1&quot;</span><span class="o">,</span> <span class="s">&quot;2&quot;</span><span class="o">})</span> <span class="nx">List</span><span class="o">&lt;</span><span class="nx">Integer</span><span class="o">&gt;</span> <span class="nx">numbersOfLimbs</span><span class="o">)</span> <span class="o">{</span>
-  <span class="o">...</span>
+<span class="nx">ist</span><span class="o">&lt;</span><span class="nx">Cat</span><span class="o">&gt;</span> <span class="nf">findCats</span><span class="o">(</span><span class="nd">@Header</span> <span class="nd">@Default</span><span class="o">(</span><span class="s">&quot;age&quot;</span><span class="o">)</span> <span class="nx">String</span> <span class="nx">orderBy</span><span class="o">,</span> <span class="nd">@Default</span><span class="o">({</span><span class="s">&quot;1&quot;</span><span class="o">,</span> <span class="s">&quot;2&quot;</span><span class="o">})</span> <span class="nx">List</span><span class="o">&lt;</span><span class="nx">Integer</span><span class="o">&gt;</span> <span class="nx">numbersOfLimbs</span><span class="o">)</span> <span class="o">{</span>
+ <span class="o">...</span>
 <span class="o">}</span>
 </pre></div>
 </div>