Skip to content

Commit 396be37

Browse files
committed
doc update for v1.6.8
1 parent f154db1 commit 396be37

File tree

11 files changed

+488
-54
lines changed

11 files changed

+488
-54
lines changed

docs/faq.html

Lines changed: 105 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -634,6 +634,21 @@ <h3 id="_how_can_i_customise_the_openapi_object">How can I customise the OpenAPI
634634
}</code></pre>
635635
</div>
636636
</div>
637+
<div class="admonitionblock note">
638+
<table>
639+
<tr>
640+
<td class="icon">
641+
<i class="fa icon-note" title="Note"></i>
642+
</td>
643+
<td class="content">
644+
This bean <code>OpenApiCustomizer</code> will be applied to the Default OpenAPI only.
645+
</td>
646+
</tr>
647+
</table>
648+
</div>
649+
<div class="paragraph">
650+
<p>If you need the <code>OpenApiCustomizer</code> to applied to <code>GroupedOpenApi</code> as well, then use <code>GlobalOpenApiCustomiser</code> instead.</p>
651+
</div>
637652
</div>
638653
<div class="sect2">
639654
<h3 id="_how_can_i_return_an_empty_content_as_response">How can I return an empty content as response?</h3>
@@ -1746,12 +1761,100 @@ <h3 id="_how_can_i_define_different_description_for_a_class_attribute_depending_
17461761
</div>
17471762
</div>
17481763
<div class="sect2">
1764+
<h3 id="_customizing_swagger_static_resources">Customizing swagger static resources</h3>
1765+
<div class="paragraph">
1766+
<p>You can customize swagger documentation static resources located in <code>META-INF/resources/webjars/swagger-ui/{swagger.version}/</code>. The list of resources includes:</p>
1767+
</div>
1768+
<div class="ulist">
1769+
<ul>
1770+
<li>
1771+
<p><code>index.html</code></p>
1772+
</li>
1773+
<li>
1774+
<p><code>swagger-ui-bundle.js</code></p>
1775+
</li>
1776+
<li>
1777+
<p><code>swagger-ui.css</code></p>
1778+
</li>
1779+
<li>
1780+
<p><code>swagger-ui-standalone-preset.js</code></p>
1781+
</li>
1782+
<li>
1783+
<p><code>swagger-ui.css.map</code></p>
1784+
</li>
1785+
<li>
1786+
<p><code>swagger-ui-bundle.js.map</code></p>
1787+
</li>
1788+
<li>
1789+
<p><code>swagger-ui-standalone-preset.js.map</code></p>
1790+
</li>
1791+
<li>
1792+
<p><code>favicon-32x32.png</code></p>
1793+
</li>
1794+
</ul>
1795+
</div>
1796+
<div class="paragraph">
1797+
<p>To do this, you need to extend the implementation of <code>SwaggerIndexPageTransformer</code></p>
1798+
</div>
1799+
<div class="listingblock">
1800+
<div class="content">
1801+
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">public class SwaggerCodeBlockTransformer
1802+
extends SwaggerIndexPageTransformer {
1803+
// &lt; constructor &gt;
1804+
@Override
1805+
public Resource transform(HttpServletRequest request,
1806+
Resource resource,
1807+
ResourceTransformerChain transformer)
1808+
throws IOException {
1809+
if (resource.toString().contains("swagger-ui.css")) {
1810+
final InputStream is = resource.getInputStream();
1811+
final InputStreamReader isr = new InputStreamReader(is);
1812+
try (BufferedReader br = new BufferedReader(isr)) {
1813+
final String css = br.lines().collect(Collectors.joining());
1814+
final byte[] transformedContent = css.replace("old", "new").getBytes();
1815+
return new TransformedResource(resource, transformedContent);
1816+
} // AutoCloseable br &gt; isr &gt; is
1817+
}
1818+
return super.transform(request, resource, transformer);
1819+
}
1820+
1821+
}</code></pre>
1822+
</div>
1823+
</div>
1824+
<div class="paragraph">
1825+
<p>Next, add transformer <code>@Bean</code> to your <code>@Configuration</code></p>
1826+
</div>
1827+
<div class="listingblock">
1828+
<div class="content">
1829+
<pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java">@Configuration
1830+
public class OpenApiConfig {
1831+
@Bean
1832+
public SwaggerIndexTransformer swaggerIndexTransformer(
1833+
SwaggerUiConfigProperties a,
1834+
SwaggerUiOAuthProperties b,
1835+
SwaggerUiConfigParameters c,
1836+
SwaggerWelcomeCommon d) {
1837+
return new SwaggerCodeBlockTransformer(a, b, c, d);
1838+
}
1839+
}</code></pre>
1840+
</div>
1841+
</div>
1842+
<div class="paragraph">
1843+
<p>Illustrative example</p>
1844+
</div>
1845+
<div class="imageblock">
1846+
<div class="content">
1847+
<img src="images/static_content_transformation.png" alt="Illustrative example">
1848+
</div>
1849+
</div>
1850+
</div>
1851+
<div class="sect2">
17491852
<h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot">What is the compatibility matrix of <code>springdoc-openapi</code> with <code>spring-boot</code> ?</h3>
17501853
<div class="paragraph">
17511854
<p><code>springdoc-openapi</code> is compatible with <code>spring-boot 1</code> and <code>spring-boot 2</code>.</p>
17521855
</div>
17531856
<div class="paragraph">
1754-
<p>In general, <strong>you should only pick the last stable version as per today 1.6.7.</strong></p>
1857+
<p>In general, <strong>you should only pick the last stable version as per today 1.6.8.</strong></p>
17551858
</div>
17561859
<div class="paragraph">
17571860
<p>More precisely, this the exhaustive list of spring-boot versions against which <code>springdoc-openapi</code> has been built:</p>
@@ -1798,7 +1901,7 @@ <h3 id="_what_is_the_compatibility_matrix_of_springdoc_openapi_with_spring_boot"
17981901
</div>
17991902
<div id="footer">
18001903
<div id="footer-text">
1801-
Last updated 2022-04-08 19:19:25 +0200
1904+
Last updated 2022-04-22 02:32:02 +0200
18021905
</div>
18031906
</div>
18041907
<script src="js/highlight/highlight.min.js"></script>

docs/getting-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h2 id="getting-started">Getting Started</h2>
3030
<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"> &lt;dependency&gt;
3131
&lt;groupId&gt;org.springdoc&lt;/groupId&gt;
3232
&lt;artifactId&gt;springdoc-openapi-ui&lt;/artifactId&gt;
33-
&lt;version&gt;1.6.7&lt;/version&gt;
33+
&lt;version&gt;1.6.8&lt;/version&gt;
3434
&lt;/dependency&gt;</code></pre>
3535
</div>
3636
</div>

0 commit comments

Comments
 (0)