Skip to content

Commit 5d5c584

Browse files
bnasslahsenbnasslahsen
committed
doc update
1 parent 0ac55ef commit 5d5c584

File tree

4 files changed

+205
-73
lines changed

4 files changed

+205
-73
lines changed

‎docs/index.html

-14
Original file line numberDiff line numberDiff line change
@@ -197,20 +197,6 @@ <h1>springdoc-openapi v1.7.0</h1>
197197
</ul>
198198
</li>
199199
</ul>
200-
201-
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-8127371937306964"
202-
crossorigin="anonymous"></script>
203-
<!-- footer -->
204-
<ins class="adsbygoogle"
205-
style="display:block"
206-
data-ad-client="ca-pub-8127371937306964"
207-
data-ad-slot="7587139264"
208-
data-ad-format="auto"
209-
data-full-width-responsive="true"></ins>
210-
<script>
211-
(adsbygoogle = window.adsbygoogle || []).push({});
212-
</script>
213-
214200
</div>
215201
</div>
216202
<div id="content">

‎docs/v2/index.html

+97-29
Original file line numberDiff line numberDiff line change
@@ -464,10 +464,20 @@ <h3 id="spring-webflux-support"><a class="anchor" href="#spring-webflux-support"
464464
<div class="sect2">
465465
<h3 id="spring-hateoas-support"><a class="anchor" href="#spring-hateoas-support"></a>3.4. Spring Hateoas support</h3>
466466
<div class="paragraph">
467-
<p>The support for Spring Hateoas is available using the dependency springdoc-openapi-hateoas.
468-
The projects that use <code>spring-boot-starter-hateoas</code> should use:
469-
- <code>springdoc-openapi-starter-webmvc-api</code> if they need only the access to the OpenAPI endpoints
470-
- OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they need also the access to the swagger-ui</p>
467+
<p>The support for Spring Hateoas is available using the dependency springdoc-openapi-hateoas.</p>
468+
</div>
469+
<div class="paragraph">
470+
<p>The projects that use <code>spring-boot-starter-hateoas</code> should use:</p>
471+
</div>
472+
<div class="ulist">
473+
<ul>
474+
<li>
475+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they need only the access to the OpenAPI endpoints</p>
476+
</li>
477+
<li>
478+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they need also the access to the swagger-ui</p>
479+
</li>
480+
</ul>
471481
</div>
472482
</div>
473483
<div class="sect2">
@@ -476,23 +486,45 @@ <h3 id="spring-data-rest-support"><a class="anchor" href="#spring-data-rest-supp
476486
<p><code>springdoc-openapi</code> project supports <code>spring-boot-starter-data-rest</code> types like: <code>@RepositoryRestResource</code> and <code>QuerydslPredicate</code> annotations.</p>
477487
</div>
478488
<div class="paragraph">
479-
<p>The projects that use <code>spring-boot-starter-data-rest</code> should use:
480-
- <code>springdoc-openapi-starter-webmvc-api</code> if they need only the access to the OpenAPI endpoints
481-
- OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they need also the access to the swagger-ui</p>
489+
<p>The projects that use <code>spring-boot-starter-data-rest</code> should use:</p>
490+
</div>
491+
<div class="ulist">
492+
<ul>
493+
<li>
494+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they need only the access to the OpenAPI endpoints</p>
495+
</li>
496+
<li>
497+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they need also the access to the swagger-ui</p>
498+
</li>
499+
</ul>
482500
</div>
483501
</div>
484502
<div class="sect2">
485503
<h3 id="spring-security-support"><a class="anchor" href="#spring-security-support"></a>3.6. Spring Security support</h3>
486504
<div class="paragraph">
487-
<p><code>springdoc-openapi</code> helps ignoring @AuthenticationPrincipal type in case it is used on REST Controllers.
488-
<code>springdoc-openapi</code> supports also exposing Oauth2 endpoints of <code>spring-security-oauth2-authorization-server</code>.</p>
505+
<p><code>springdoc-openapi</code> helps ignoring @AuthenticationPrincipal type in case it is used on REST Controllers.</p>
489506
</div>
490507
<div class="paragraph">
491-
<p>The projects that use <code>spring-boot-starter-security</code> or <code>spring-security-oauth2-authorization-server</code> should use:
492-
- <code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.
493-
- OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.
494-
- OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.
495-
- OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
508+
<p><code>springdoc-openapi</code> supports also exposing Oauth2 endpoints of <code>spring-security-oauth2-authorization-server</code>.</p>
509+
</div>
510+
<div class="paragraph">
511+
<p>The projects that use <code>spring-boot-starter-security</code> or <code>spring-security-oauth2-authorization-server</code> should use:</p>
512+
</div>
513+
<div class="ulist">
514+
<ul>
515+
<li>
516+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
517+
</li>
518+
<li>
519+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
520+
</li>
521+
<li>
522+
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
523+
</li>
524+
<li>
525+
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
526+
</li>
527+
</ul>
496528
</div>
497529
</div>
498530
<div class="sect2">
@@ -760,11 +792,23 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.9. Kotlin
760792
<p><code>springdoc-openapi</code> supports Kotlin types.</p>
761793
</div>
762794
<div class="paragraph">
763-
<p>The projects that use <code>Kotlin</code> should use:
764-
- <code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.
765-
- OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.
766-
- OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.
767-
- OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
795+
<p>The projects that use <code>Kotlin</code> should use:</p>
796+
</div>
797+
<div class="ulist">
798+
<ul>
799+
<li>
800+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
801+
</li>
802+
<li>
803+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
804+
</li>
805+
<li>
806+
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
807+
</li>
808+
<li>
809+
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
810+
</li>
811+
</ul>
768812
</div>
769813
<div class="admonitionblock note">
770814
<table>
@@ -790,11 +834,23 @@ <h3 id="kotlin-support"><a class="anchor" href="#kotlin-support"></a>3.9. Kotlin
790834
<div class="sect2">
791835
<h3 id="groovy-support"><a class="anchor" href="#groovy-support"></a>3.10. Groovy support</h3>
792836
<div class="paragraph">
793-
<p>The projects that use <code>Groovy</code> should use:
794-
- <code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.
795-
- OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.
796-
- OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.
797-
- OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
837+
<p>The projects that use <code>Groovy</code> should use:</p>
838+
</div>
839+
<div class="ulist">
840+
<ul>
841+
<li>
842+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
843+
</li>
844+
<li>
845+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
846+
</li>
847+
<li>
848+
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
849+
</li>
850+
<li>
851+
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
852+
</li>
853+
</ul>
798854
</div>
799855
</div>
800856
<div class="sect2">
@@ -816,11 +872,23 @@ <h3 id="javadoc-support"><a class="anchor" href="#javadoc-support"></a>3.11. Jav
816872
</ul>
817873
</div>
818874
<div class="paragraph">
819-
<p>The projects that needs <code>Javadoc</code> support should use:
820-
- <code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.
821-
- OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.
822-
- OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.
823-
- OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
875+
<p>The projects that needs <code>Javadoc</code> support should use:</p>
876+
</div>
877+
<div class="ulist">
878+
<ul>
879+
<li>
880+
<p><code>springdoc-openapi-starter-webmvc-api</code> if they depend on <code>spring-boot-starter-web</code> and they only need the access to the OpenAPI endpoints.</p>
881+
</li>
882+
<li>
883+
<p>OR <code>springdoc-openapi-starter-webmvc-ui</code>, if they depend on <code>spring-boot-starter-web</code> and they also need the access to the swagger-ui.</p>
884+
</li>
885+
<li>
886+
<p>OR <code>springdoc-openapi-starter-webflux-api</code> if they depend on <code>spring-boot-starter-webflux</code> and they only the access to the OpenAPI endpoints.</p>
887+
</li>
888+
<li>
889+
<p>OR <code>springdoc-openapi-starter-webflux-ui</code>, if they depend on <code>spring-boot-starter-webflux</code> and they also need the access to the swagger-ui.</p>
890+
</li>
891+
</ul>
824892
</div>
825893
<div class="admonitionblock note">
826894
<table>

0 commit comments

Comments
 (0)