Skip to content
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.

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

[Feature/#7-swagger] Swagger 설정 #8

Merged
merged 1 commit into from
May 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ dependencies {
implementation group: 'com.googlecode.json-simple', name: 'json-simple', version: '1.1.1'

// Swagger3 gradle
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.2'

implementation group: 'org.springdoc', name: 'springdoc-openapi-starter-webmvc-ui', version: '2.1.0'
implementation group: 'io.swagger.core.v3', name: 'swagger-core-jakarta', version: '2.2.7'

//S3+CloudFront
implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
Expand Down
59 changes: 26 additions & 33 deletions src/main/java/com/cookiee/cookieeserver/config/SwaggerConfig.java
Original file line number Diff line number Diff line change
@@ -1,48 +1,41 @@


package com.cookiee.cookieeserver.config;


import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import lombok.RequiredArgsConstructor;

import org.springdoc.core.customizers.OpenApiCustomizer;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@OpenAPIDefinition(
info = @Info(title = "Cookiee API 명세서",
description = "Cookiee API 명세서 입니다.",
version = "v1"))
@RequiredArgsConstructor

import io.swagger.v3.oas.models.info.Info;

@Configuration
public class SwaggerConfig implements WebMvcConfigurer {
public class SwaggerConfig {

@Bean
public OpenApiCustomizer customOpenApiCustomizer() {
return openApi -> openApi.info(apiInfo("Cookiee- API"));
}

//http://localhost:8080/swagger-ui/index.html#/
@Bean
public GroupedOpenApi chatOpenApi() {
String[] paths = {"/**"};
public OpenApiCustomizer userOpenApiCustomizer() {
return openApi -> openApi.info(apiInfo("cookiee-service"));
}

@Bean
public GroupedOpenApi userApi() {
return GroupedOpenApi.builder()
.group("Cookiee API v1")
.pathsToMatch(paths)
.group("SERVICE")
.pathsToMatch("/api/**")
.addOpenApiCustomizer(customOpenApiCustomizer())
.addOpenApiCustomizer(userOpenApiCustomizer())
.build();
}

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");

registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
// -- Static resources
registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
registry.addResourceHandler("/css/**").addResourceLocations("classpath:/static/css");
registry.addResourceHandler("/js/**").addResourceLocations("classpath:/static/js/");
registry.addResourceHandler("/images/**").addResourceLocations("classpath:/static/images/");

private Info apiInfo(String title) {
return new Info()
.title(title)
.description("포토 캘린더 서비스, Cookiee-")
.version("1.0.0");
}
}
}