https://github.com/playtikaoss/rapidoc-spring-boot

Rapidoc Open Api UI for Spring Boot
https://github.com/playtikaoss/rapidoc-spring-boot

openapi3 rapidoc spring-boot swagger swagger-ui

Last synced: 2 months ago
JSON representation

Rapidoc Open Api UI for Spring Boot

• Host: GitHub
• URL: https://github.com/playtikaoss/rapidoc-spring-boot
• Owner: PlaytikaOSS
• License: mit
• Created: 2022-06-03T20:08:47.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-20T16:01:19.000Z (almost 2 years ago)
• Last Synced: 2024-10-01T06:22:59.090Z (3 months ago)
• Topics: openapi3, rapidoc, spring-boot, swagger, swagger-ui
• Language: Java
• Homepage:
• Size: 287 KB
• Stars: 7
• Watchers: 6
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= Rapidoc Spring Boot Library

:toc:

*TLDR:* Modern Swagger UI for your Open Api specification in Spring Boot services.

== Who is expected to use this library?

- you have OpenApi Specification file for your API;

- you use https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin[OpenApi Code Generator plugin];

- you want Swagger UI to be based on original OpenApi Specification file;

- you like how https://rapidocweb.com/index.html[RapiDoc] UI looks like;

- you have Spring Boot application.

== How UI looks like?

image::rapidoc-ui.png[width=800]

Or have a look here: https://rapidocweb.com/examples/petstore-extended.html

== How to configure?

. *[Important]* Remove SpringDoc and Swagger UI dependencies

+

Make sure that there is no `org.springdoc : springdoc-openapi-ui` and `org.webjars : swagger-ui` dependencies on classpath.

. Add dependency `com.playtika : rapidoc-spring-boot`

+

--

[source,xml]

----

    com.playtika

    rapidoc-spring-boot

    insert_version_here

----

--

. Configure properties

+

|===

|Property |Description |Default value

|`openapi.rapidoc.enabled`

|Enables/disables autoconfiguration for Rapidoc.

|`true`

|`openapi.rapidoc.open-api-spec.file-name`

|Name of the Open Api Spec file.

|`openapi.yaml`

|`openapi.rapidoc.open-api-spec.path`

|Path to the Open Api Spec file inside `/src/main/resources` folder.

|`/openapi/`

|===

== Available endpoints

Library exposes the following endpoints:

- `/v3/api-docs` -- provides Open Api Specification file;

- `/swagger-ui.html` -- provides RapiDoc UI for the Open Api Specification.

== Demo project

Demo project is located in module `rapidoc-spring-boot-demo`. Start application and hit `http://localhost:8080/swagger-ui.html` in browser.