Commit 3b75e62

committed

add: SpringDoc OpenAPI to Spring Boot Projec and Define API Information using Annotations

1 parent 7dbfe7e commit 3b75e62Copy full SHA for 3b75e62

File tree

+33

-0

lines changed

+33

-0

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,12 @@`
`89`	`89`	`<scope>runtime</scope>`
`90`	`90`	`</dependency>`
`91`	`91`
	`92`	`+ <!-- https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-starter-webmvc-ui -->`
	`93`	`+ <dependency>`
	`94`	`+ <groupId>org.springdoc</groupId>`
	`95`	`+ <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>`
	`96`	`+ <version>2.1.0</version>`
	`97`	`+ </dependency>`
`92`	`98`
`93`	`99`	`</dependencies>`
`94`	`100`

Lines changed: 25 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,36 @@`
`1`	`1`	`package com.springboot.blog;`
`2`	`2`
	`3`	`+import io.swagger.v3.oas.annotations.ExternalDocumentation;`
	`4`	`+import io.swagger.v3.oas.annotations.OpenAPIDefinition;`
	`5`	`+import io.swagger.v3.oas.annotations.info.Contact;`
	`6`	`+import io.swagger.v3.oas.annotations.info.Info;`
	`7`	`+import io.swagger.v3.oas.annotations.info.License;`
`3`	`8`	`import org.modelmapper.ModelMapper;`
`4`	`9`	`import org.springframework.boot.SpringApplication;`
`5`	`10`	`import org.springframework.boot.autoconfigure.SpringBootApplication;`
`6`	`11`	`import org.springframework.context.annotation.Bean;`
`7`	`12`
`8`	`13`	`@SpringBootApplication`
	`14`	`+@OpenAPIDefinition(`
	`15`	`+ info = @Info(`
	`16`	`+ title = "Spring Boot Blog App REST APIs",`
	`17`	`+ description = "Spring Boot Blog App REST APIs documentation",`
	`18`	`+ version = "v1.0",`
	`19`	`+ contact = @Contact(`
	`20`	`+ name = "Adilet Kozubaev",`
	`21`	`+ email = "adiletkdev@gmail.com",`
	`22`	`+ url = "https://www.******.net"`
	`23`	`+ ),`
	`24`	`+ license = @License(`
	`25`	`+ name = "Apache 2.0",`
	`26`	`+ url = "https://www.******.net/license"`
	`27`	`+ )`
	`28`	`+ ),`
	`29`	`+ externalDocs = @ExternalDocumentation(`
	`30`	`+ description = "Spring Boot Blog App documentation",`
	`31`	`+ url = "https://github.com/adiletkdev/springboot-blog-rest-api"`
	`32`	`+ )`
	`33`	`+)`
`9`	`34`	`public class SpringbootBlogRestApiApplication {`
`10`	`35`
`11`	`36`	`@Bean`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,8 @@ SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {`
`56`	`56`	`//authorize.anyRequest().authenticated()`
`57`	`57`	`authorize.requestMatchers(HttpMethod.GET, "/api/**").permitAll()`
`58`	`58`	`.requestMatchers("/api/auth/**").permitAll()`
	`59`	`+ .requestMatchers("/swagger-ui/**").permitAll()`
	`60`	`+ .requestMatchers("/v3/api-docs/**").permitAll()`
`59`	`61`	`.anyRequest().authenticated()`
`60`	`62`
`61`	`63`	`).exceptionHandling(exception -> exception`

Comments

(0)