2호선 VIP

README.md

@@ -1 +1,75 @@
-# jwp-subway-path
+# jwp-subway-path
+
+## Quick Start
+
+```text
+cd docker
+
+docker-compose -p subway up
+```
+
+## API 문서
+
+```text
+http://localhost:8080/swagger-ui/index.html#/
+```
+
+## 기능 요구사항
+
+### 역
+
+- [x] 역은 고유한 식별자를 가진다.
+- [x] 역 이름은 `역`으로 끝나야 한다.
+- [x] 역 이름은 2글자에서 11글자까지 가능하다.
+- [x] 역 이름은 한글 + 숫자로만 이루어져야 한다.
+
+### 구역
+
+- [x] 구역은 두 역과 역 사이의 거리를 가진다.
+- [x] 거리는 양의 정수이고, 단위는 km이다.
+
+### 노선
+
+- [x] 노선 이름은 숫자 + `호선` 이다.
+    - [x] 숫자는 1 ~ 9까지 가능하다.
+
+- [x] 노선의 색은 `색`으로 끝나야 한다.
+    - [x] 색 이름은 2글자에서 11글자까지 가능하다.
+
+- [x] 역을 추가할 수 있어야 한다.
+    -[x] 역을 추가할 때, 상행, 하행 역의 정보와 거리 정보를 입력받는다.
+    - 최초 등록이 아닐 경우, 상행역 또는 하행역 어느 한 가지도 존재하지 않으면 예외를 던진다.
+    -[x] 하나의 역은 여러 노선에 등록될 수 있다.
+    -[x] 두 역의 가운데에 다른 역을 등록할 때, 기존 거리를 고려해야 한다.
+
+- [x] 역이 2개 이상 등록된 노선을 전부 보여주어야 한다.
+
+- [x] 구역은 역 순서대로 저장되어 있어야 한다.
+    - [x] 노선 번호를 입력받으면, 노선에 포함된 역을 순서대로 보여주어야 한다.
+
+- [x] 역을 제거할 수 있어야 한다.
+    -[x] 역을 제거하면 남은 역을 재배치 해야 한다.
+    -[x] 노선에서 역이 제거되면 역과 역 사이의 거리도 재배정되어야 한다.
+    -[x] 노선에 등록된 역이 2개인 경우 하나의 역을 제거할 때 두 역이 모두 제거되어야 한다.
+
+### 지하철
+
+- [x] 출발역과 도착역 사이의 최단 경로를 구한다.
+    - [x] 총 거리 정보를 함께 응답한다.
+
+### 요금 정책
+
+- [x] 거리에 따른 요금을 계산한다.
+    - 기본운임(10㎞ 이내): 기본운임 1,250원
+    - 이용 거리 초과 시 추가운임 부과
+        - 10km~50km: 5km 까지 마다 100원 추가
+        - 50km 초과: 8km 까지 마다 100원 추가
+
+- [x] 노선에 따른 요금을 계산한다.
+    - 추가 요금이 있는 노선을 이용하면 측정된 요금에 추가한다.
+    - 경로 중 추가 요금이 있는 노선을 환승하여 이용하면 가장 높은 금액의 추가 요금만 적용한다.
+
+- [x] 연령에 따른 요금 할인을 계산한다.
+    - 연령에 따른 요금 할인 정책을 반영한다.
+        - 청소년: 운임에서 350원을 공제한 금액의 20% 할인
+        - 어린이: 운임에서 350원을 공제한 금액의 50% 할인

build.gradle

@@ -1,27 +1,30 @@
 plugins {
-	id 'java'
-	id 'org.springframework.boot' version '2.7.9'
-	id 'io.spring.dependency-management' version '1.0.15.RELEASE'
+    id 'java'
+    id 'org.springframework.boot' version '2.7.9'
+    id 'io.spring.dependency-management' version '1.0.15.RELEASE'
 }
 
 sourceCompatibility = '11'
 
 repositories {
-	mavenCentral()
+    mavenCentral()
 }
 
 dependencies {
-	implementation 'org.springframework.boot:spring-boot-starter-web'
-	implementation 'org.springframework.boot:spring-boot-starter-jdbc'
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'org.springframework.boot:spring-boot-starter-jdbc'
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
+    implementation 'net.rakugakibox.spring.boot:logback-access-spring-boot-starter:2.7.1'
+    implementation 'org.springdoc:springdoc-openapi-ui:1.7.0'
+    implementation 'org.jgrapht:jgrapht-core:1.5.2'
+    implementation 'mysql:mysql-connector-java:8.0.33'
 
-	implementation 'net.rakugakibox.spring.boot:logback-access-spring-boot-starter:2.7.1'
+    testImplementation 'io.rest-assured:rest-assured:4.4.0'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
 
-	testImplementation 'io.rest-assured:rest-assured:4.4.0'
-	testImplementation 'org.springframework.boot:spring-boot-starter-test'
-
-	runtimeOnly 'com.h2database:h2'
+    runtimeOnly 'com.h2database:h2'
 }
 
 test {
-	useJUnitPlatform()
-}
+    useJUnitPlatform()
+}

docker/.env

@@ -0,0 +1,4 @@
+MYSQL_DATABASE=subway
+MYSQL_ROOT_PASSWORD=1234
+MYSQL_USER=subway
+MYSQL_PASSWORD=1234

docker/docker-compose.yml

@@ -0,0 +1,37 @@
+version: "3"
+services:
+  app:
+    container_name: app
+    image: arm64v8/amazoncorretto:11-alpine-jdk
+    ports:
+      - "8080:8080"
+    environment:
+      SPRING_DATASOURCE_URL: jdbc:mysql://db:3306/${MYSQL_DATABASE}?serverTimezone=Asia/Seoul&characterEncoding=UTF-8
+      SPRING_DATASOURCE_USERNAME: ${MYSQL_USER}
+      SPRING_DATASOURCE_PASSWORD: ${MYSQL_PASSWORD}
+    volumes:
+      - ../src:/app/src
+      - ../gradle:/app/gradle
+      - ../build.gradle:/app/build.gradle
+      - ../gradlew:/app/gradlew
+      - ../gradlew.bat:/app/gradlew.bat
+    working_dir: /app
+    command: [ "./gradlew", "bootrun" ]
+    depends_on:
+      - db
+    restart: always
+
+  db:
+    container_name: db
+    image: mysql:8.0.33
+    ports:
+      - "3307:3306"
+    environment:
+      MYSQL_DATABASE: ${MYSQL_DATABASE}
+      MYSQL_ROOT_PASSWORD: ${MYSQL_ROOT_PASSWORD}
+      MYSQL_USER: ${MYSQL_USER}
+      MYSQL_PASSWORD: ${MYSQL_PASSWORD}
+    volumes:
+      - ../src/main/resources/data.sql:/docker-entrypoint-initdb.d/init.sql
+      - ./mysql.cnf:/etc/mysql/conf.d/mysql.cnf
+    restart: always

docker/mysql.cnf

@@ -0,0 +1,44 @@
+# Copyright (c) 2015, 2021, Oracle and/or its affiliates.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2.0,
+# as published by the Free Software Foundation.
+#
+# This program is also distributed with certain software (including
+# but not limited to OpenSSL) that is licensed under separate terms,
+# as designated in a particular file or component or in included license
+# documentation.  The authors of MySQL hereby grant you an additional
+# permission to link the program and your derivative works with the
+# separately licensed software that they have included with MySQL.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License, version 2.0, for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+
+#
+# The MySQL  Client configuration file.
+#
+# For explanations see
+# http://dev.mysql.com/doc/mysql/en/server-system-variables.html
+
+[client]
+default-character-set=utf8mb4
+
+[mysqld]
+character-set-client-handshake=FALSE
+init_connect="SET collation_connection=utf8mb4_unicode_ci"
+init_connect="SET NAMES utf8mb4"
+character-set-server=utf8mb4
+default_time_zone=Asia/Seoul
+lower_case_table_names=1
+
+[mysql]
+default-character-set=utf8mb4
+
+[mysqldump]
+default-character-set=utf8mb4

src/main/java/subway/SubwayApplication.java

@@ -6,8 +6,8 @@
 @SpringBootApplication
 public class SubwayApplication {
 
-	public static void main(String[] args) {
-		SpringApplication.run(SubwayApplication.class, args);
-	}
+    public static void main(String[] args) {
+        SpringApplication.run(SubwayApplication.class, args);
+    }
 
 }

src/main/java/subway/config/SwaggerConfiguration.java

@@ -0,0 +1,22 @@
+package subway.config;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerConfiguration {
+
+    @Bean
+    public OpenAPI openAPI() {
+        final Info info = new Info()
+                .title("지하철 API Document")
+                .version("v0.0.1")
+                .description("지하철 API 명세서입니다.");
+        return new OpenAPI()
+                .components(new Components())
+                .info(info);
+    }
+}