├── .gitignore ├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── README.md ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main ├── java │ └── com │ │ └── bezkoder │ │ └── spring │ │ └── swagger │ │ ├── SpringBootSwagger3ExampleApplication.java │ │ ├── config │ │ └── OpenAPIConfig.java │ │ ├── controller │ │ └── TutorialController.java │ │ ├── model │ │ └── Tutorial.java │ │ └── service │ │ └── TutorialService.java └── resources │ └── application.properties └── test └── java └── com └── bezkoder └── spring └── swagger └── SpringBootSwagger3ExampleApplicationTests.java /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bezkoder/spring-boot-swagger-3-example/c17197300ba6abf725ad12b2114bb49e4b21f5fd/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | # Licensed to the Apache Software Foundation (ASF) under one 2 | # or more contributor license agreements. See the NOTICE file 3 | # distributed with this work for additional information 4 | # regarding copyright ownership. The ASF licenses this file 5 | # to you under the Apache License, Version 2.0 (the 6 | # "License"); you may not use this file except in compliance 7 | # with the License. You may obtain a copy of the License at 8 | # 9 | # https://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, 12 | # software distributed under the License is distributed on an 13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14 | # KIND, either express or implied. See the License for the 15 | # specific language governing permissions and limitations 16 | # under the License. 17 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.7/apache-maven-3.8.7-bin.zip 18 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar 19 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Swagger 3 and Spring Boot example (with OpenAPI 3) 2 | 3 | Document REST API with Swagger 3 in Spring Boot example (follow OpenAPI 3 specification). You will also know several ways to configure Swagger API description and response. 4 | 5 | For more detail, please visit: 6 | > [Spring Boot with Swagger 3 example](https://www.bezkoder.com/spring-boot-swagger-3/) 7 | 8 | You can also apply the code easily on following Projects: 9 | > [Spring Boot 3 REST API example](https://www.bezkoder.com/spring-boot-3-rest-api/) 10 | 11 | > [Spring Boot Rest API with H2](https://www.bezkoder.com/spring-boot-jpa-h2-example/) 12 | 13 | > [Spring Boot Rest API with MySQL](https://www.bezkoder.com/spring-boot-jpa-crud-rest-api/) 14 | 15 | > [Spring Boot Rest API with PostgreSQL](https://www.bezkoder.com/spring-boot-postgresql-example/) 16 | 17 | > [Spring Boot Rest API with SQL Server](https://www.bezkoder.com/spring-boot-sql-server/) 18 | 19 | > [Spring Boot Rest API with MongoDB](https://www.bezkoder.com/spring-boot-mongodb-crud/) 20 | 21 | > [Spring Boot Rest API with Cassandra](https://www.bezkoder.com/spring-boot-cassandra-crud/) 22 | 23 | > [Spring Boot Rest API with Oracle](https://www.bezkoder.com/spring-boot-hibernate-oracle/) 24 | 25 | Front-end that works well with this Back-end 26 | > [Angular 8 Client](https://www.bezkoder.com/angular-crud-app/) / [Angular 10 Client](https://www.bezkoder.com/angular-10-crud-app/) / [Angular 11 Client](https://www.bezkoder.com/angular-11-crud-app/) / [Angular 12 Client](https://www.bezkoder.com/angular-12-crud-app/) / [Angular 13 Client](https://www.bezkoder.com/angular-13-crud-example/) / [Angular 14 Client](https://www.bezkoder.com/angular-14-crud-example/) / [Angular 15 Client](https://www.bezkoder.com/angular-15-crud-example/) 27 | 28 | > [Vue 2 Client](https://www.bezkoder.com/vue-js-crud-app/) / [Vue 3 Client](https://www.bezkoder.com/vue-3-crud/) / [Vuetify Client](https://www.bezkoder.com/vuetify-data-table-example/) 29 | 30 | > [React Client](https://www.bezkoder.com/react-hooks-crud-axios-api/) / [React Redux Client](https://www.bezkoder.com/redux-toolkit-crud-react-hooks/) 31 | 32 | More Practice: 33 | > [Spring Boot File upload example with Multipart File](https://www.bezkoder.com/spring-boot-file-upload/) 34 | 35 | > [Spring Boot Pagination & Filter example | Spring JPA, Pageable](https://www.bezkoder.com/spring-boot-pagination-filter-jpa-pageable/) 36 | 37 | > [Spring Data JPA Sort/Order by multiple Columns | Spring Boot](https://www.bezkoder.com/spring-data-sort-multiple-columns/) 38 | 39 | > [Spring Boot Repository Unit Test with @DataJpaTest](https://www.bezkoder.com/spring-boot-unit-test-jpa-repo-datajpatest/) 40 | 41 | > [Deploy Spring Boot App on AWS – Elastic Beanstalk](https://www.bezkoder.com/deploy-spring-boot-aws-eb/) 42 | 43 | Exception Handling: 44 | > [Spring Boot @ControllerAdvice & @ExceptionHandler example](https://www.bezkoder.com/spring-boot-controlleradvice-exceptionhandler/) 45 | 46 | > [@RestControllerAdvice example in Spring Boot](https://www.bezkoder.com/spring-boot-restcontrolleradvice/) 47 | 48 | Security: 49 | > [Spring Boot + Spring Security JWT Authentication & Authorization](https://www.bezkoder.com/spring-boot-jwt-authentication/) 50 | 51 | Fullstack: 52 | > [Vue + Spring Boot example](https://www.bezkoder.com/spring-boot-vue-js-crud-example/) 53 | 54 | > [Angular 8 + Spring Boot example](https://www.bezkoder.com/angular-spring-boot-crud/) 55 | 56 | > [Angular 10 + Spring Boot example](https://www.bezkoder.com/angular-10-spring-boot-crud/) 57 | 58 | > [Angular 11 + Spring Boot example](https://www.bezkoder.com/angular-11-spring-boot-crud/) 59 | 60 | > [Angular 12 + Spring Boot example](https://www.bezkoder.com/angular-12-spring-boot-crud/) 61 | 62 | > [Angular 13 + Spring Boot example](https://www.bezkoder.com/spring-boot-angular-13-crud/) 63 | 64 | > [Angular 14 + Spring Boot example](https://www.bezkoder.com/spring-boot-angular-14-crud/) 65 | 66 | > [Angular 15 + Spring Boot example](https://www.bezkoder.com/spring-boot-angular-15-crud/) 67 | 68 | > [React + Spring Boot + MySQL example](https://www.bezkoder.com/react-spring-boot-crud/) 69 | 70 | > [React + Spring Boot + PostgreSQL example](https://www.bezkoder.com/spring-boot-react-postgresql/) 71 | 72 | Run both Back-end & Front-end in one place: 73 | > [Integrate Angular with Spring Boot Rest API](https://www.bezkoder.com/integrate-angular-spring-boot/) 74 | 75 | > [Integrate React.js with Spring Boot Rest API](https://www.bezkoder.com/integrate-reactjs-spring-boot/) 76 | 77 | > [Integrate Vue.js with Spring Boot Rest API](https://www.bezkoder.com/integrate-vue-spring-boot/) 78 | 79 | ## Run Spring Boot application 80 | ``` 81 | mvn spring-boot:run 82 | ``` 83 | 84 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ] ; then 38 | 39 | if [ -f /usr/local/etc/mavenrc ] ; then 40 | . /usr/local/etc/mavenrc 41 | fi 42 | 43 | if [ -f /etc/mavenrc ] ; then 44 | . /etc/mavenrc 45 | fi 46 | 47 | if [ -f "$HOME/.mavenrc" ] ; then 48 | . "$HOME/.mavenrc" 49 | fi 50 | 51 | fi 52 | 53 | # OS specific support. $var _must_ be set to either true or false. 54 | cygwin=false; 55 | darwin=false; 56 | mingw=false 57 | case "`uname`" in 58 | CYGWIN*) cygwin=true ;; 59 | MINGW*) mingw=true;; 60 | Darwin*) darwin=true 61 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 62 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 63 | if [ -z "$JAVA_HOME" ]; then 64 | if [ -x "/usr/libexec/java_home" ]; then 65 | export JAVA_HOME="`/usr/libexec/java_home`" 66 | else 67 | export JAVA_HOME="/Library/Java/Home" 68 | fi 69 | fi 70 | ;; 71 | esac 72 | 73 | if [ -z "$JAVA_HOME" ] ; then 74 | if [ -r /etc/gentoo-release ] ; then 75 | JAVA_HOME=`java-config --jre-home` 76 | fi 77 | fi 78 | 79 | if [ -z "$M2_HOME" ] ; then 80 | ## resolve links - $0 may be a link to maven's home 81 | PRG="$0" 82 | 83 | # need this for relative symlinks 84 | while [ -h "$PRG" ] ; do 85 | ls=`ls -ld "$PRG"` 86 | link=`expr "$ls" : '.*-> \(.*\)$'` 87 | if expr "$link" : '/.*' > /dev/null; then 88 | PRG="$link" 89 | else 90 | PRG="`dirname "$PRG"`/$link" 91 | fi 92 | done 93 | 94 | saveddir=`pwd` 95 | 96 | M2_HOME=`dirname "$PRG"`/.. 97 | 98 | # make it fully qualified 99 | M2_HOME=`cd "$M2_HOME" && pwd` 100 | 101 | cd "$saveddir" 102 | # echo Using m2 at $M2_HOME 103 | fi 104 | 105 | # For Cygwin, ensure paths are in UNIX format before anything is touched 106 | if $cygwin ; then 107 | [ -n "$M2_HOME" ] && 108 | M2_HOME=`cygpath --unix "$M2_HOME"` 109 | [ -n "$JAVA_HOME" ] && 110 | JAVA_HOME=`cygpath --unix "$JAVA_HOME"` 111 | [ -n "$CLASSPATH" ] && 112 | CLASSPATH=`cygpath --path --unix "$CLASSPATH"` 113 | fi 114 | 115 | # For Mingw, ensure paths are in UNIX format before anything is touched 116 | if $mingw ; then 117 | [ -n "$M2_HOME" ] && 118 | M2_HOME="`(cd "$M2_HOME"; pwd)`" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`" 121 | fi 122 | 123 | if [ -z "$JAVA_HOME" ]; then 124 | javaExecutable="`which javac`" 125 | if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then 126 | # readlink(1) is not available as standard on Solaris 10. 127 | readLink=`which readlink` 128 | if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then 129 | if $darwin ; then 130 | javaHome="`dirname \"$javaExecutable\"`" 131 | javaExecutable="`cd \"$javaHome\" && pwd -P`/javac" 132 | else 133 | javaExecutable="`readlink -f \"$javaExecutable\"`" 134 | fi 135 | javaHome="`dirname \"$javaExecutable\"`" 136 | javaHome=`expr "$javaHome" : '\(.*\)/bin'` 137 | JAVA_HOME="$javaHome" 138 | export JAVA_HOME 139 | fi 140 | fi 141 | fi 142 | 143 | if [ -z "$JAVACMD" ] ; then 144 | if [ -n "$JAVA_HOME" ] ; then 145 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 146 | # IBM's JDK on AIX uses strange locations for the executables 147 | JAVACMD="$JAVA_HOME/jre/sh/java" 148 | else 149 | JAVACMD="$JAVA_HOME/bin/java" 150 | fi 151 | else 152 | JAVACMD="`\\unset -f command; \\command -v java`" 153 | fi 154 | fi 155 | 156 | if [ ! -x "$JAVACMD" ] ; then 157 | echo "Error: JAVA_HOME is not defined correctly." >&2 158 | echo " We cannot execute $JAVACMD" >&2 159 | exit 1 160 | fi 161 | 162 | if [ -z "$JAVA_HOME" ] ; then 163 | echo "Warning: JAVA_HOME environment variable is not set." 164 | fi 165 | 166 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 167 | 168 | # traverses directory structure from process work directory to filesystem root 169 | # first directory with .mvn subdirectory is considered project base directory 170 | find_maven_basedir() { 171 | 172 | if [ -z "$1" ] 173 | then 174 | echo "Path not specified to find_maven_basedir" 175 | return 1 176 | fi 177 | 178 | basedir="$1" 179 | wdir="$1" 180 | while [ "$wdir" != '/' ] ; do 181 | if [ -d "$wdir"/.mvn ] ; then 182 | basedir=$wdir 183 | break 184 | fi 185 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 186 | if [ -d "${wdir}" ]; then 187 | wdir=`cd "$wdir/.."; pwd` 188 | fi 189 | # end of workaround 190 | done 191 | echo "${basedir}" 192 | } 193 | 194 | # concatenates all lines of a file 195 | concat_lines() { 196 | if [ -f "$1" ]; then 197 | echo "$(tr -s '\n' ' ' < "$1")" 198 | fi 199 | } 200 | 201 | BASE_DIR=`find_maven_basedir "$(pwd)"` 202 | if [ -z "$BASE_DIR" ]; then 203 | exit 1; 204 | fi 205 | 206 | ########################################################################################## 207 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 208 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 209 | ########################################################################################## 210 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 211 | if [ "$MVNW_VERBOSE" = true ]; then 212 | echo "Found .mvn/wrapper/maven-wrapper.jar" 213 | fi 214 | else 215 | if [ "$MVNW_VERBOSE" = true ]; then 216 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 217 | fi 218 | if [ -n "$MVNW_REPOURL" ]; then 219 | jarUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 220 | else 221 | jarUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 222 | fi 223 | while IFS="=" read key value; do 224 | case "$key" in (wrapperUrl) jarUrl="$value"; break ;; 225 | esac 226 | done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 227 | if [ "$MVNW_VERBOSE" = true ]; then 228 | echo "Downloading from: $jarUrl" 229 | fi 230 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 231 | if $cygwin; then 232 | wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"` 233 | fi 234 | 235 | if command -v wget > /dev/null; then 236 | if [ "$MVNW_VERBOSE" = true ]; then 237 | echo "Found wget ... using wget" 238 | fi 239 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 240 | wget "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 241 | else 242 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 243 | fi 244 | elif command -v curl > /dev/null; then 245 | if [ "$MVNW_VERBOSE" = true ]; then 246 | echo "Found curl ... using curl" 247 | fi 248 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 249 | curl -o "$wrapperJarPath" "$jarUrl" -f 250 | else 251 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 252 | fi 253 | 254 | else 255 | if [ "$MVNW_VERBOSE" = true ]; then 256 | echo "Falling back to using Java to download" 257 | fi 258 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 259 | # For Cygwin, switch paths to Windows format before running javac 260 | if $cygwin; then 261 | javaClass=`cygpath --path --windows "$javaClass"` 262 | fi 263 | if [ -e "$javaClass" ]; then 264 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 265 | if [ "$MVNW_VERBOSE" = true ]; then 266 | echo " - Compiling MavenWrapperDownloader.java ..." 267 | fi 268 | # Compiling the Java class 269 | ("$JAVA_HOME/bin/javac" "$javaClass") 270 | fi 271 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 272 | # Running the downloader 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Running MavenWrapperDownloader.java ..." 275 | fi 276 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 277 | fi 278 | fi 279 | fi 280 | fi 281 | ########################################################################################## 282 | # End of extension 283 | ########################################################################################## 284 | 285 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 286 | if [ "$MVNW_VERBOSE" = true ]; then 287 | echo $MAVEN_PROJECTBASEDIR 288 | fi 289 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 290 | 291 | # For Cygwin, switch paths to Windows format before running java 292 | if $cygwin; then 293 | [ -n "$M2_HOME" ] && 294 | M2_HOME=`cygpath --path --windows "$M2_HOME"` 295 | [ -n "$JAVA_HOME" ] && 296 | JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"` 297 | [ -n "$CLASSPATH" ] && 298 | CLASSPATH=`cygpath --path --windows "$CLASSPATH"` 299 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 300 | MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"` 301 | fi 302 | 303 | # Provide a "standardized" way to retrieve the CLI args that will 304 | # work with both Windows and non-Windows executions. 305 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 306 | export MAVEN_CMD_LINE_ARGS 307 | 308 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 309 | 310 | exec "$JAVACMD" \ 311 | $MAVEN_OPTS \ 312 | $MAVEN_DEBUG_OPTS \ 313 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 314 | "-Dmaven.home=${M2_HOME}" \ 315 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 316 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 317 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 50 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 124 | 125 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% ^ 162 | %JVM_CONFIG_MAVEN_PROPS% ^ 163 | %MAVEN_OPTS% ^ 164 | %MAVEN_DEBUG_OPTS% ^ 165 | -classpath %WRAPPER_JAR% ^ 166 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 167 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 168 | if ERRORLEVEL 1 goto error 169 | goto end 170 | 171 | :error 172 | set ERROR_CODE=1 173 | 174 | :end 175 | @endlocal & set ERROR_CODE=%ERROR_CODE% 176 | 177 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 178 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 179 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 180 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 181 | :skipRcPost 182 | 183 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 184 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 185 | 186 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 187 | 188 | cmd /C exit /B %ERROR_CODE% 189 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 3.0.4 10 | 11 | 12 | com.bezkoder 13 | spring-boot-swagger-3-example 14 | 0.0.1-SNAPSHOT 15 | spring-boot-swagger-3-example 16 | Spring Boot and Swagger 3 example: Rest API Documentation 17 | 18 | 17 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-web 24 | 25 | 26 | 27 | org.springdoc 28 | springdoc-openapi-starter-webmvc-ui 29 | 2.0.3 30 | 31 | 32 | 33 | org.springframework.boot 34 | spring-boot-starter-test 35 | test 36 | 37 | 38 | 39 | 40 | 41 | 42 | org.springframework.boot 43 | spring-boot-maven-plugin 44 | 45 | 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /src/main/java/com/bezkoder/spring/swagger/SpringBootSwagger3ExampleApplication.java: -------------------------------------------------------------------------------- 1 | package com.bezkoder.spring.swagger; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class SpringBootSwagger3ExampleApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(SpringBootSwagger3ExampleApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/bezkoder/spring/swagger/config/OpenAPIConfig.java: -------------------------------------------------------------------------------- 1 | package com.bezkoder.spring.swagger.config; 2 | 3 | import java.util.List; 4 | 5 | import org.springframework.beans.factory.annotation.Value; 6 | import org.springframework.context.annotation.Bean; 7 | import org.springframework.context.annotation.Configuration; 8 | 9 | import io.swagger.v3.oas.models.OpenAPI; 10 | import io.swagger.v3.oas.models.info.Contact; 11 | import io.swagger.v3.oas.models.info.Info; 12 | import io.swagger.v3.oas.models.info.License; 13 | import io.swagger.v3.oas.models.servers.Server; 14 | 15 | @Configuration 16 | public class OpenAPIConfig { 17 | 18 | @Value("${bezkoder.openapi.dev-url}") 19 | private String devUrl; 20 | 21 | @Value("${bezkoder.openapi.prod-url}") 22 | private String prodUrl; 23 | 24 | @Bean 25 | public OpenAPI myOpenAPI() { 26 | Server devServer = new Server(); 27 | devServer.setUrl(devUrl); 28 | devServer.setDescription("Server URL in Development environment"); 29 | 30 | Server prodServer = new Server(); 31 | prodServer.setUrl(prodUrl); 32 | prodServer.setDescription("Server URL in Production environment"); 33 | 34 | Contact contact = new Contact(); 35 | contact.setEmail("bezkoder@gmail.com"); 36 | contact.setName("BezKoder"); 37 | contact.setUrl("https://www.bezkoder.com"); 38 | 39 | License mitLicense = new License().name("MIT License").url("https://choosealicense.com/licenses/mit/"); 40 | 41 | Info info = new Info() 42 | .title("Tutorial Management API") 43 | .version("1.0") 44 | .contact(contact) 45 | .description("This API exposes endpoints to manage tutorials.").termsOfService("https://www.bezkoder.com/terms") 46 | .license(mitLicense); 47 | 48 | return new OpenAPI().info(info).servers(List.of(devServer, prodServer)); 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /src/main/java/com/bezkoder/spring/swagger/controller/TutorialController.java: -------------------------------------------------------------------------------- 1 | package com.bezkoder.spring.swagger.controller; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | import org.springframework.beans.factory.annotation.Autowired; 7 | import org.springframework.http.HttpStatus; 8 | import org.springframework.http.ResponseEntity; 9 | import org.springframework.web.bind.annotation.CrossOrigin; 10 | import org.springframework.web.bind.annotation.DeleteMapping; 11 | import org.springframework.web.bind.annotation.GetMapping; 12 | import org.springframework.web.bind.annotation.PathVariable; 13 | import org.springframework.web.bind.annotation.PostMapping; 14 | import org.springframework.web.bind.annotation.PutMapping; 15 | import org.springframework.web.bind.annotation.RequestBody; 16 | import org.springframework.web.bind.annotation.RequestMapping; 17 | import org.springframework.web.bind.annotation.RequestParam; 18 | import org.springframework.web.bind.annotation.RestController; 19 | 20 | import com.bezkoder.spring.swagger.model.Tutorial; 21 | import com.bezkoder.spring.swagger.service.TutorialService; 22 | 23 | import io.swagger.v3.oas.annotations.Operation; 24 | import io.swagger.v3.oas.annotations.media.Content; 25 | import io.swagger.v3.oas.annotations.media.Schema; 26 | import io.swagger.v3.oas.annotations.responses.ApiResponse; 27 | import io.swagger.v3.oas.annotations.responses.ApiResponses; 28 | import io.swagger.v3.oas.annotations.tags.Tag; 29 | 30 | @Tag(name = "Tutorial", description = "Tutorial management APIs") 31 | @CrossOrigin(origins = "http://localhost:8081") 32 | @RestController 33 | @RequestMapping("/api") 34 | public class TutorialController { 35 | @Autowired 36 | TutorialService tutorialService; 37 | 38 | @Operation(summary = "Create a new Tutorial", tags = { "tutorials", "post" }) 39 | @ApiResponses({ 40 | @ApiResponse(responseCode = "201", content = { 41 | @Content(schema = @Schema(implementation = Tutorial.class), mediaType = "application/json") }), 42 | @ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) }) 43 | @PostMapping("/tutorials") 44 | public ResponseEntity createTutorial(@RequestBody Tutorial tutorial) { 45 | try { 46 | Tutorial _tutorial = tutorialService 47 | .save(new Tutorial(tutorial.getTitle(), tutorial.getDescription(), tutorial.isPublished())); 48 | return new ResponseEntity<>(_tutorial, HttpStatus.CREATED); 49 | } catch (Exception e) { 50 | return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR); 51 | } 52 | } 53 | 54 | @Operation(summary = "Retrieve all Tutorials", tags = { "tutorials", "get", "filter" }) 55 | @ApiResponses({ 56 | @ApiResponse(responseCode = "200", content = { 57 | @Content(schema = @Schema(implementation = Tutorial.class), mediaType = "application/json") }), 58 | @ApiResponse(responseCode = "204", description = "There are no Tutorials", content = { 59 | @Content(schema = @Schema()) }), 60 | @ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) }) 61 | @GetMapping("/tutorials") 62 | public ResponseEntity> getAllTutorials(@RequestParam(required = false) String title) { 63 | try { 64 | List tutorials = new ArrayList(); 65 | 66 | if (title == null) 67 | tutorialService.findAll().forEach(tutorials::add); 68 | else 69 | tutorialService.findByTitleContaining(title).forEach(tutorials::add); 70 | 71 | if (tutorials.isEmpty()) { 72 | return new ResponseEntity<>(HttpStatus.NO_CONTENT); 73 | } 74 | 75 | return new ResponseEntity<>(tutorials, HttpStatus.OK); 76 | } catch (Exception e) { 77 | return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR); 78 | } 79 | } 80 | 81 | @Operation( 82 | summary = "Retrieve a Tutorial by Id", 83 | description = "Get a Tutorial object by specifying its id. The response is Tutorial object with id, title, description and published status.", 84 | tags = { "tutorials", "get" }) 85 | @ApiResponses({ 86 | @ApiResponse(responseCode = "200", content = { @Content(schema = @Schema(implementation = Tutorial.class), mediaType = "application/json") }), 87 | @ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }), 88 | @ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) }) 89 | @GetMapping("/tutorials/{id}") 90 | public ResponseEntity getTutorialById(@PathVariable("id") long id) { 91 | Tutorial tutorial = tutorialService.findById(id); 92 | 93 | if (tutorial != null) { 94 | return new ResponseEntity<>(tutorial, HttpStatus.OK); 95 | } else { 96 | return new ResponseEntity<>(HttpStatus.NOT_FOUND); 97 | } 98 | } 99 | 100 | @Operation(summary = "Update a Tutorial by Id", tags = { "tutorials", "put" }) 101 | @ApiResponses({ 102 | @ApiResponse(responseCode = "200", content = { 103 | @Content(schema = @Schema(implementation = Tutorial.class), mediaType = "application/json") }), 104 | @ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }), 105 | @ApiResponse(responseCode = "404", content = { @Content(schema = @Schema()) }) }) 106 | @PutMapping("/tutorials/{id}") 107 | public ResponseEntity updateTutorial(@PathVariable("id") long id, @RequestBody Tutorial tutorial) { 108 | Tutorial _tutorial = tutorialService.findById(id); 109 | 110 | if (_tutorial != null) { 111 | _tutorial.setTitle(tutorial.getTitle()); 112 | _tutorial.setDescription(tutorial.getDescription()); 113 | _tutorial.setPublished(tutorial.isPublished()); 114 | return new ResponseEntity<>(tutorialService.save(_tutorial), HttpStatus.OK); 115 | } else { 116 | return new ResponseEntity<>(HttpStatus.NOT_FOUND); 117 | } 118 | } 119 | 120 | @Operation(summary = "Delete a Tutorial by Id", tags = { "tutorials", "delete" }) 121 | @ApiResponses({ @ApiResponse(responseCode = "204", content = { @Content(schema = @Schema()) }), 122 | @ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) }) 123 | @DeleteMapping("/tutorials/{id}") 124 | public ResponseEntity deleteTutorial(@PathVariable("id") long id) { 125 | try { 126 | tutorialService.deleteById(id); 127 | return new ResponseEntity<>(HttpStatus.NO_CONTENT); 128 | } catch (Exception e) { 129 | return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR); 130 | } 131 | } 132 | 133 | @Operation(summary = "Delete all Tutorials", tags = { "tutorials", "delete" }) 134 | @ApiResponses({ @ApiResponse(responseCode = "204", content = { @Content(schema = @Schema()) }), 135 | @ApiResponse(responseCode = "500", content = { @Content(schema = @Schema()) }) }) 136 | @DeleteMapping("/tutorials") 137 | public ResponseEntity deleteAllTutorials() { 138 | try { 139 | tutorialService.deleteAll(); 140 | return new ResponseEntity<>(HttpStatus.NO_CONTENT); 141 | } catch (Exception e) { 142 | return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR); 143 | } 144 | 145 | } 146 | 147 | @Operation(summary = "Retrieve all published Tutorials", tags = { "tutorials", "get", "filter" }) 148 | @GetMapping("/tutorials/published") 149 | public ResponseEntity> findByPublished() { 150 | try { 151 | List tutorials = tutorialService.findByPublished(true); 152 | 153 | if (tutorials.isEmpty()) { 154 | return new ResponseEntity<>(HttpStatus.NO_CONTENT); 155 | } 156 | return new ResponseEntity<>(tutorials, HttpStatus.OK); 157 | } catch (Exception e) { 158 | return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR); 159 | } 160 | } 161 | } 162 | -------------------------------------------------------------------------------- /src/main/java/com/bezkoder/spring/swagger/model/Tutorial.java: -------------------------------------------------------------------------------- 1 | package com.bezkoder.spring.swagger.model; 2 | 3 | import io.swagger.v3.oas.annotations.media.Schema; 4 | 5 | public class Tutorial { 6 | 7 | @Schema(accessMode = Schema.AccessMode.READ_ONLY) 8 | private long id = 0; 9 | 10 | private String title; 11 | 12 | private String description; 13 | 14 | private boolean published; 15 | 16 | public Tutorial() { 17 | 18 | } 19 | 20 | public Tutorial(String title, String description, boolean published) { 21 | this.title = title; 22 | this.description = description; 23 | this.published = published; 24 | } 25 | 26 | public void setId(long id) { 27 | this.id = id; 28 | } 29 | 30 | public long getId() { 31 | return id; 32 | } 33 | 34 | public String getTitle() { 35 | return title; 36 | } 37 | 38 | public void setTitle(String title) { 39 | this.title = title; 40 | } 41 | 42 | public String getDescription() { 43 | return description; 44 | } 45 | 46 | public void setDescription(String description) { 47 | this.description = description; 48 | } 49 | 50 | public boolean isPublished() { 51 | return published; 52 | } 53 | 54 | public void setPublished(boolean isPublished) { 55 | this.published = isPublished; 56 | } 57 | 58 | @Override 59 | public String toString() { 60 | return "Tutorial [id=" + id + ", title=" + title + ", desc=" + description + ", published=" + published + "]"; 61 | } 62 | 63 | } 64 | -------------------------------------------------------------------------------- /src/main/java/com/bezkoder/spring/swagger/service/TutorialService.java: -------------------------------------------------------------------------------- 1 | package com.bezkoder.spring.swagger.service; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | import org.springframework.stereotype.Service; 7 | 8 | import com.bezkoder.spring.swagger.model.Tutorial; 9 | 10 | @Service 11 | public class TutorialService { 12 | 13 | static List tutorials = new ArrayList(); 14 | static long id = 0; 15 | 16 | public List findAll() { 17 | return tutorials; 18 | } 19 | 20 | public List findByTitleContaining(String title) { 21 | return tutorials.stream().filter(tutorial -> tutorial.getTitle().contains(title)).toList(); 22 | } 23 | 24 | public Tutorial findById(long id) { 25 | return tutorials.stream().filter(tutorial -> id == tutorial.getId()).findAny().orElse(null); 26 | } 27 | 28 | public Tutorial save(Tutorial tutorial) { 29 | // update Tutorial 30 | if (tutorial.getId() != 0) { 31 | long _id = tutorial.getId(); 32 | 33 | for (int idx = 0; idx < tutorials.size(); idx++) 34 | if (_id == tutorials.get(idx).getId()) { 35 | tutorials.set(idx, tutorial); 36 | break; 37 | } 38 | 39 | return tutorial; 40 | } 41 | 42 | // create new Tutorial 43 | tutorial.setId(++id); 44 | tutorials.add(tutorial); 45 | return tutorial; 46 | } 47 | 48 | public void deleteById(long id) { 49 | tutorials.removeIf(tutorial -> id == tutorial.getId()); 50 | } 51 | 52 | public void deleteAll() { 53 | tutorials.removeAll(tutorials); 54 | } 55 | 56 | public List findByPublished(boolean isPublished) { 57 | return tutorials.stream().filter(tutorial -> isPublished == tutorial.isPublished()).toList(); 58 | } 59 | } 60 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | #springdoc.api-docs.enabled=false 2 | #springdoc.swagger-ui.enabled=false 3 | #springdoc.packages-to-scan=com.bezkoder.spring.swagger.controller 4 | springdoc.swagger-ui.path=/bezkoder-documentation 5 | springdoc.api-docs.path=/bezkoder-api-docs 6 | #springdoc.swagger-ui.operationsSorter=method 7 | #springdoc.swagger-ui.tagsSorter=alpha 8 | springdoc.swagger-ui.tryItOutEnabled=true 9 | springdoc.swagger-ui.filter=true 10 | 11 | bezkoder.openapi.dev-url=http://localhost:8080 12 | bezkoder.openapi.prod-url=https://bezkoder-api.com -------------------------------------------------------------------------------- /src/test/java/com/bezkoder/spring/swagger/SpringBootSwagger3ExampleApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.bezkoder.spring.swagger; 2 | 3 | import org.junit.jupiter.api.Test; 4 | import org.springframework.boot.test.context.SpringBootTest; 5 | 6 | @SpringBootTest 7 | class SpringBootSwagger3ExampleApplicationTests { 8 | 9 | @Test 10 | void contextLoads() { 11 | } 12 | 13 | } 14 | --------------------------------------------------------------------------------