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

[Docs] : Swagger API 명세서 구현 #17

Merged
merged 3 commits into from
Jun 4, 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
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ dependencies {
runtimeOnly 'com.h2database:h2'
annotationProcessor 'org.projectlombok:lombok'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.4'
runtimeOnly 'com.mysql:mysql-connector-j'
}

Expand Down
29 changes: 29 additions & 0 deletions src/main/java/usay/app/global/config/SwaggerConfig.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package usay.app.global.config;

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.annotations.info.Info;
import lombok.RequiredArgsConstructor;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@OpenAPIDefinition(
info = @Info(
title = "Usay API",
description = "SwaggerTest API Docs",
version = "v1"
))
@RequiredArgsConstructor
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi chatOpenApi() {
String[] paths = {"/**"};

return GroupedOpenApi.builder()
.group("Usay API v1")
.pathsToMatch(paths)
.build();
}
}
11 changes: 11 additions & 0 deletions src/main/resources/application.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@ spring:
defer-datasource-initialization: true
database-platform: org.hibernate.dialect.H2Dialect

springdoc:
api-docs:
path: /api-docs.json
groups:
enabled: true
default-consumes-media-type: application/json
default-produces-media-type: application/json
swagger-ui: # Path : localhost:8080/swagger-ui.html
tags-sorter: alpha
operations-sorter: alpha

logging:
level:
org.hibernate.orm.jdbc.bind: trace
Expand Down
Loading