[F팀] 백엔드 파트 코드리뷰용 PR

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 어떤 버그인가요?
+
+> 어떤 버그인지 간결하게 설명해주세요
+
+## 어떤 상황에서 발생한 버그인가요?
+
+> (가능하면) Given-When-Then 형식으로 서술해주세요
+
+## 예상 결과
+
+> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요
+
+## 참고할만한 자료(선택)

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 어떤 기능인가요?
+
+> 추가하려는 기능에 대해 간결하게 설명해주세요
+
+## 작업 상세 내용
+
+- [ ] TODO
+- [ ] TODO
+- [ ] TODO
+
+## 참고할만한 자료(선택)

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## #️⃣연관된 이슈
+
+> ex) #이슈번호, #이슈번호
+
+## 📝작업 내용
+
+> 이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
+
+### 스크린샷 (선택)
+
+## 💬리뷰 요구사항(선택)
+
+> 리뷰어가 특별히 봐주었으면 하는 부분이 있다면 작성해주세요

.gitignore

@@ -43,4 +43,12 @@ out/
 .DS_Store
 
 ### applicaion 제외 ###
-src/main/resources/application.yaml
+src/main/resources/application.yaml
+Ping-Api/src/main/resources/application.yaml
+
+### rest docs ###
+**/src/main/resources/static/docs/
+Ping-Api/src/main/resources/static/swagger/openapi3.yaml
+
+### docker compose ###
+docker-compose.yaml

Ping-Api/build.gradle.kts

@@ -0,0 +1 @@
+plugins {    `java-test-fixtures`    id("org.asciidoctor.jvm.convert") version "3.3.2"    id("com.epages.restdocs-api-spec") version "0.17.1"}repositories {    mavenCentral()}val asciidoctorExt = "asciidoctorExt"configurations.create(asciidoctorExt) {    extendsFrom(configurations.testImplementation.get())}dependencies {    implementation(project(":Ping-Application"))    implementation(project(":Ping-Common"))    implementation(project(":Ping-Domain"))    implementation(project(":Ping-Infra"))    implementation(project(":Ping-Client"))    implementation(project(":Ping-Support"))    implementation("org.springframework.boot:spring-boot-starter-data-mongodb")    testImplementation("com.epages:restdocs-api-spec-mockmvc:0.19.2")    testImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")    asciidoctorExt("org.springframework.restdocs:spring-restdocs-asciidoctor")    testFixturesImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")    testImplementation("com.epages:restdocs-api-spec-mockmvc:0.17.1")    testImplementation("org.mockito.kotlin:mockito-kotlin:4.0.0")}tasks {    bootJar {        isEnabled = true    }    jar {        isEnabled = true    }}val snippetDir = file("build/generated-snippets")tasks.asciidoctor {    inputs.dir(snippetDir)    dependsOn(tasks.test)    configurations(asciidoctorExt)    baseDirFollowsSourceFile()}tasks.bootJar{    dependsOn(tasks.asciidoctor)    from("build/docs/asciidoc"){        into("static/docs")    }}tasks.register("copyDocs", Copy::class){    dependsOn(tasks.bootJar)    from("build/docs/asciidoc")    into("src/main/resources/static/docs")}tasks.build {    dependsOn(tasks.getByName("copyDocs"))}openapi3 {    this.setServer("https://localhost:8080")    title = "Moping API"    description = "모핑 API 명세서 입니다"    version = "1.0.0"    format = "yaml"}tasks.bootJar{    dependsOn("openapi3")    from("build/api-spec") {        into("static/swagger")    }}tasks.register("copyYaml", Copy::class){    dependsOn("openapi3")    from("build/api-spec")    into("src/main/resources/static/swagger")}tasks.build {    dependsOn(tasks.getByName("copyYaml"))}

Ping-Api/src/docs/asciidoc/Auth.adoc

@@ -0,0 +1,6 @@
+[[Auth-API]]
+== Auth API
+
+[[Post-ReissueToken]]
+=== 토큰 재발급
+operation::AuthControllerTest/reissueToken[snippets='http-request,http-response,request-headers,response-fields']

Ping-Api/src/docs/asciidoc/Event.adoc

@@ -0,0 +1,6 @@
+[[Events-API]]
+== Events API
+
+[[Post-Event]]
+=== 이벤트 생성
+operation::EventControllerTest/createEvent[snippets='http-request,request-fields,http-response,response-fields']

Ping-Api/src/docs/asciidoc/NonMember.adoc

@@ -0,0 +1,14 @@
+[[NonMembers-API]]
+== NonMembers API
+
+[[Post-NonMemberLogin]]
+=== 비회원 로그인
+operation::NonMemberControllerTest/loginNonMember[snippets='http-request,request-fields,http-response']
+
+[[Post-NonMemberLoginWithToken]]
+=== 비회원 로그인 (토큰 발급)
+operation::NonMemberControllerTest/loginNonMemberWithToken[snippets='http-request,request-fields,http-response,response-fields']
+
+[[Get-NonMemberProfile]]
+=== 비회원 프로필 불러오기
+operation::NonMemberControllerTest/getNonMemberProfile[snippets='http-request,http-response,response-fields']

Ping-Api/src/docs/asciidoc/Pings.adoc

@@ -0,0 +1,46 @@
+[[Pings-API]]
+== Pings API
+
+[[Post-IsCorrectBookmarkUrl]]
+=== 유효한 북마크 링크
+operation::PingControllerTest/isCorrectBookmarkUrl[snippets='http-request,http-response,request-fields,request-body']
+
+[[List-IsCorrectStoreUrl]]
+=== 유효한 가게 링크
+operation::PingControllerTest/isCorrectStoreUrl[snippets='http-request,http-response,request-fields,request-body']
+
+[[Post-NonMemberPings]]
+=== 비회원 핑 생성
+operation::PingControllerTest/createNonMemberPings[snippets='http-request,request-fields,http-response']
+
+[[Post-SaveMemberPing]]
+=== 회원 핑 저장
+operation::PingControllerTest/saveMemberPing[snippets='http-request,http-response,request-headers,request-fields']
+
+[[Post-RecommendPings]]
+=== 추천 핑 저장
+operation::PingControllerTest/saveRecommendPings[snippets='http-request,http-response,request-fields,response-fields']
+
+[[Get-NonMemberPings]]
+=== 전체 핑 불러오기
+operation::PingControllerTest/getAllNonMemberPings[snippets='http-request,http-response,query-parameters,response-body,response-fields']
+
+[[Get-NonMemberPing]]
+=== 개별 핑 불러오기
+operation::PingControllerTest/getNonMemberPing[snippets='http-request,http-response,response-fields']
+
+[[Get-RecommendPings]]
+=== 추천 핑 불러오기
+operation::PingControllerTest/getRecommendPings[snippets='http-request,http-response,query-parameters,response-fields']
+
+[[Put-UpdateNonMemberPings]]
+=== 비회원 핑 업데이트
+operation::PingControllerTest/updateNonMemberPings[snippets='http-request,request-fields,http-response']
+
+[[Get-RefreshAllNonMemberPings]]
+=== 비회원 모든 핑 갱신
+operation::PingControllerTest/refreshAllNonMemberPings[snippets='http-request,http-response,query-parameters,response-fields']
+
+[[Delete-MemberPing]]
+=== 회원 핑 삭제
+operation::PingControllerTest/deletePing[snippets='http-request,http-response,request-headers,request-fields']

Ping-Api/src/docs/asciidoc/Place.adoc

@@ -0,0 +1,14 @@
+[[Places-API]]
+== Places API
+
+[[Search-Place]]
+=== 장소 검색
+operation::PlaceControllerTest/searchPlace[snippets='http-request,query-parameters,http-response,response-body,response-fields']
+
+[[Geocode-Place]]
+=== 주소로 좌표 검색
+operation::PlaceControllerTest/getGeocodePlace[snippets='http-request,query-parameters,http-response,response-body,response-fields']
+
+[[Reverse-Geocode-Place]]
+=== 도로명 주소 조회
+operation::PlaceControllerTest/getReverseGeocode[snippets='http-request,query-parameters,http-response,response-body,response-fields']

Ping-Api/src/docs/asciidoc/index.adoc

@@ -0,0 +1,13 @@
+= Moping-Backend API Docs
+:doctype: book
+:icons: font
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 2
+:sectlinks:
+
+include::Event.adoc[]
+include::Auth.adoc[]
+include::NonMember.adoc[]
+include::Place.adoc[]
+include::Pings.adoc[]

Ping-Api/src/main/kotlin/com/ping/api/PingApplication.kt

@@ -0,0 +1,27 @@
+package com.ping.api
+
+import org.springframework.boot.autoconfigure.SpringBootApplication
+import org.springframework.boot.context.properties.ConfigurationPropertiesScan
+import org.springframework.boot.runApplication
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories
+import org.springframework.scheduling.annotation.EnableScheduling
+
+@EnableScheduling
+@ConfigurationPropertiesScan
+@EnableMongoRepositories(basePackages = ["com.ping.infra"])
+@SpringBootApplication(
+    scanBasePackages = [
+        "com.ping.api",
+        "com.ping.application",
+        "com.ping.common",
+        "com.ping.domain",
+        "com.ping.infra",
+        "com.ping.client",
+        "com.ping.support",
+    ]
+)
+class PingApplication
+
+fun main(args: Array<String>) {
+    runApplication<PingApplication>(*args)
+}

Ping-Api/src/main/kotlin/com/ping/api/event/EventApi.kt

@@ -0,0 +1,5 @@
+package com.ping.api.event
+
+object EventApi {
+    const val BASE_URL = "/event"
+}

Ping-Api/src/main/kotlin/com/ping/api/event/EventController.kt

@@ -0,0 +1,22 @@
+package com.ping.api.event
+
+import com.ping.application.event.service.EventService
+import com.ping.application.event.dto.CreateEvent
+import com.ping.common.exception.SuccessResponse
+import io.swagger.v3.oas.annotations.tags.Tag
+import org.springframework.http.HttpStatus
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.PostMapping
+import org.springframework.web.bind.annotation.RequestBody
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class EventController(
+    private val eventService: EventService,
+) {
+    @PostMapping(EventApi.BASE_URL)
+    fun create(@RequestBody request: CreateEvent.Request): ResponseEntity<SuccessResponse<CreateEvent.Response>> {
+        val response = eventService.create(request)
+        return ResponseEntity.ok(SuccessResponse.of(HttpStatus.OK, "공유 URL이 성공적으로 생성되었습니다.", response))
+    }
+}

Ping-Api/src/main/kotlin/com/ping/api/event/PlaceApi.kt

@@ -0,0 +1,8 @@
+package com.ping.api.event
+
+object PlaceApi {
+    const val BASE_URL = "/places"
+    const val SEARCH = "$BASE_URL/search"
+    const val GEOCODE = "$BASE_URL/geocode"
+    const val REVERSE_GEOCODE = "$BASE_URL/reverse-geocode"
+}

Ping-Api/src/main/kotlin/com/ping/api/event/PlaceController.kt

@@ -0,0 +1,35 @@
+package com.ping.api.event
+
+import com.ping.application.event.service.PlaceService
+import com.ping.application.event.dto.GeocodePlace
+import com.ping.application.event.dto.SearchPlace
+import com.ping.common.exception.SuccessResponse
+import org.springframework.http.HttpStatus
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.GetMapping
+import org.springframework.web.bind.annotation.RequestParam
+import org.springframework.web.bind.annotation.RestController
+
+@RestController
+class PlaceController(
+    private val placeService: PlaceService,
+) {
+
+    @GetMapping(PlaceApi.SEARCH)
+    fun searchPlace(@RequestParam("keyword") keyword: String): ResponseEntity<SuccessResponse<List<SearchPlace.Response>>> {
+        val response = placeService.searchPlace(keyword);
+        return ResponseEntity.ok(SuccessResponse.of(HttpStatus.OK, "장소 검색 성공", response))
+    }
+
+    @GetMapping(PlaceApi.GEOCODE)
+    fun getGeocodePlace(@RequestParam("address") address: String): ResponseEntity<SuccessResponse<GeocodePlace.Response>> {
+        val response = placeService.getGeocodeAddress(address)
+        return ResponseEntity.ok(SuccessResponse.of(HttpStatus.OK, "좌표 검색 성공", response))
+    }
+
+    @GetMapping(PlaceApi.REVERSE_GEOCODE)
+    fun getReverseGeocode(@RequestParam("px") px: Double, @RequestParam("py") py: Double): ResponseEntity<SuccessResponse<String?>> {
+        val response = placeService.getReverseGeocode(px, py)
+        return ResponseEntity.ok(SuccessResponse.of(HttpStatus.OK, "도로명 주소 조회 성공", response))
+    }
+}

Ping-Api/src/main/kotlin/com/ping/api/global/StaticRoutingConfig.kt

@@ -0,0 +1,13 @@
+package com.ping.api.global
+
+import org.springframework.context.annotation.Configuration
+import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
+
+@Configuration
+class StaticRoutingConfig : WebMvcConfigurer {
+    override fun addResourceHandlers(registry: ResourceHandlerRegistry) {
+        registry.addResourceHandler("/static/swagger/**").addResourceLocations("classpath:/static/swagger/")
+        registry.addResourceHandler("swagger-ui.html").addResourceLocations("classpath:/static/swagger/swagger-ui/")
+    }
+}

Ping-Api/src/main/kotlin/com/ping/api/member/AuthApi.kt

@@ -0,0 +1,6 @@
+package com.ping.api.member
+
+object AuthApi {
+    const val BASE_URL = "/auth"
+    const val REISSUE = "$BASE_URL/reissue"
+}

Ping-Api/src/main/kotlin/com/ping/api/member/AuthController.kt

@@ -0,0 +1,18 @@
+package com.ping.api.member
+
+import com.ping.application.member.dto.TokenResponse
+import com.ping.application.member.service.AuthService
+import jakarta.servlet.http.HttpServletRequest
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.*
+
+@RestController
+class AuthController(
+    private val authService: AuthService
+) {
+    @PostMapping(AuthApi.REISSUE)
+    fun reissueToken(request: HttpServletRequest): TokenResponse {
+        val newAccessToken = authService.reissueToken(request)
+        return newAccessToken
+    }
+}

Ping-Api/src/main/kotlin/com/ping/api/member/NonMemberApi.kt

@@ -0,0 +1,8 @@
+package com.ping.api.member
+
+object NonMemberApi {
+    const val BASE_URL = "/nonmembers"
+    const val LOGIN = "$BASE_URL/login"
+    const val LOGIN_TOKEN = "$BASE_URL/login-token"
+    const val NONMEMBER_ID = "$BASE_URL/{nonMemberId}"
+}

Ping-Api/src/main/kotlin/com/ping/api/member/NonMemberController.kt

@@ -0,0 +1,26 @@
+package com.ping.api.member
+
+import com.ping.application.member.dto.GetNonMemberProfile
+import com.ping.application.member.dto.LoginNonMember
+import com.ping.application.member.dto.LoginTokenNonMember
+import com.ping.application.member.service.NonMemberService
+import com.ping.application.ping.dto.*
+import org.springframework.web.bind.annotation.*
+
+@RestController
+class NonMemberController(
+    private val nonMemberService: NonMemberService
+) {
+    @PutMapping(NonMemberApi.LOGIN)
+    fun loginNonMember(@RequestBody request: LoginNonMember.Request): LoginNonMember.Response {
+        return nonMemberService.login(request)
+    }
+    @PostMapping(NonMemberApi.LOGIN_TOKEN)
+    fun loginNonMemberWithToken(@RequestBody request: LoginNonMember.Request): LoginTokenNonMember.Response {
+        return nonMemberService.loginWithToken(request)
+    }
+    @GetMapping(NonMemberApi.NONMEMBER_ID)
+    fun getNonMemberProfile(@PathVariable nonMemberId: Long): GetNonMemberProfile.Response {
+        return nonMemberService.getNonMemberProfile(nonMemberId)
+    }
+}

Ping-Api/src/main/kotlin/com/ping/api/ping/PingApi.kt

@@ -0,0 +1,11 @@
+package com.ping.api.ping
+
+object PingApi {
+    const val BASE_URL = "/pings"
+    const val BOOKMARK = "$BASE_URL/bookmark"
+    const val STORE = "$BASE_URL/store"
+    const val PING_NONMEMBER_ID = "$BASE_URL/{nonMemberId}"
+    const val PING_REFRESH_ALL = "$BASE_URL/refresh-all"
+    const val PING_RECOMMEND = "$BASE_URL/recommend"
+    const val PING_MEMBER = "$BASE_URL/member"
+}