Skip to content

Readme.md add gradle import #2746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 4, 2024
Merged

Readme.md add gradle import #2746

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33b651a
Add gradle dependency example
divinenickname Oct 3, 2024
61c106b
change kotlin kts to native groovy
divinenickname Oct 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ This is a community-based project, not maintained by the Spring Framework Contri
* Add the `springdoc-openapi-ui` library to the list of your project dependencies (No
additional configuration is needed):

Maven
```xml
<dependency>
<groupId>org.springdoc</groupId>
Expand All @@ -106,6 +107,11 @@ This is a community-based project, not maintained by the Spring Framework Contri
</dependency>
```

Gradle
```groovy
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:latest'
```

* This step is optional: For custom path of the swagger documentation in HTML format, add
a custom springdoc property, in your spring-boot configuration file:

Expand Down Expand Up @@ -144,6 +150,7 @@ springdoc.swagger-ui.path=/swagger-ui.html
* Add the library to the list of your project dependencies. (No additional configuration
is needed)

Maven
```xml
<dependency>
<groupId>org.springdoc</groupId>
Expand All @@ -152,6 +159,11 @@ springdoc.swagger-ui.path=/swagger-ui.html
</dependency>
```

Gradle
```groovy
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:latest'
```

* This step is optional: For custom path of the OpenAPI documentation in Json format, add
a custom springdoc property, in your spring-boot configuration file:

Expand Down Expand Up @@ -189,6 +201,7 @@ and `@SecurityScheme` annotations within a Spring managed bean.
* Add the library to the list of your project dependencies (No additional configuration
is needed)

Maven
```xml
<dependency>
<groupId>org.springdoc</groupId>
Expand All @@ -197,6 +210,11 @@ and `@SecurityScheme` annotations within a Spring managed bean.
</dependency>
```

Gradle
```groovy
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:latest'
```

* This step is optional: For custom path of the swagger documentation in HTML format, add
a custom springdoc property, in your spring-boot configuration file:

Expand Down