Skip to content

Commit

Permalink
✨ swagger config 추가
Browse files Browse the repository at this point in the history
  • Loading branch information
rong5026 committed Oct 27, 2024
1 parent 13e19eb commit 6ba63e2
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
45 changes: 45 additions & 0 deletions src/main/java/com/sinabro/sinabro/config/SwaggerConfig.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package com.sinabro.sinabro.config;

import java.util.List;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.servers.Server;
import jakarta.servlet.ServletContext;

@Configuration
public class SwaggerConfig {
private static final String PROJECT_NAME = "Sinabro";
private static final String SERVER_NAME = PROJECT_NAME +" Server";
private static final String API_TITLE = PROJECT_NAME +" 서버 API 문서";
private static final String API_DESCRIPTION = PROJECT_NAME + " 서버 API 문서입니다";
private static final String GITHUB_URL = "https://github.com/Sinabr0/back";

@Value("${swagger.version}")
private String version;

@Bean
public OpenAPI openAPI(ServletContext servletContext) {
Server server = new Server().url(servletContext.getContextPath()).description(API_DESCRIPTION);
return new OpenAPI()
.servers(List.of(server))
.info(swaggerInfo());
}

private Info swaggerInfo() {
License license = new License();
license.setUrl(GITHUB_URL);
license.setName(SERVER_NAME);

return new Info()
.version("v" + version)
.title(API_TITLE)
.description(API_DESCRIPTION)
.license(license);
}
}
2 changes: 1 addition & 1 deletion src/main/resources/application.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ springdoc:
default-consumes-media-type: application/json;charset=UTF-8
default-produces-media-type: application/json;charset=UTF-8
swagger-ui:
path: /sinabro/api-docs
path: /swagger-api
disable-swagger-default-url: true
display-request-duration: true
tags-sorter: alpha
Expand Down

0 comments on commit 6ba63e2

Please sign in to comment.