Skip to content
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
90 changes: 84 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,90 @@
# WELCOME TO SPOT !
<h1 align='center'>WELCOME TO SPOT-API-SERVER!</h1>

![TEAM LOGO)](https://github.com/user-attachments/assets/cb6b5577-2f24-40bc-997d-2946493171dd)
# ABOUT DOCS

## (0) WHAT IS SPOT?
# ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ป CONTRIBUTOR

<div align='center'>
<table>
<tr>
<td align="center">
<a href="https://github.com/42kko">
<img src="https://github.com/42kko.png" width="100px" style="border-radius: 50%;" alt="kdozlo"/>
</a>
<br/>
<b>42kko</b>
</td>
<td align="center">
<a href="https://github.com/dalcheonroadhead">
<img src="https://github.com/dalcheonroadhead.png" width="100px" style="border-radius: 50%;" alt="dalcheonroadhead"/>
</a>
<br/>
<b>dalcheonroadhead</b>
</td>
</tr>
</table>
<br/>
</div>
# ๐Ÿ“œ ๊ธฐ๋Šฅ ํ•œ ๋ˆˆ์— ๋ณด๊ธฐ

> **๋งํฌ๋ฅผ ํ†ตํ•ด** ๊ฐ ๊ตฌํ˜„์ž์˜ **`๊ณ ๋ฏผ์‚ฌํ•ญ`**๊ณผ **`๊ณ ๋„ํ™” ๊ณผ์ •`**์„ ์ž์„ธํžˆ ๋ณด์„ธ์š”! ๐Ÿš€



## ๐Ÿค ์ผ๊ฑฐ๋ฆฌ ๋งค์นญ ์„œ๋น„์Šค

### ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ผ ๋‹ด๋‹น์ž

| <img src="https://github.com/dalcheonroadhead.png" width="100px" style="border-radius: 50%;" alt="dalcheonroadhead" align = 'center'/> | ๋‹ด๋‹น์ž ํ•œ๋งˆ๋”” |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| <img src='https://img.shields.io/badge/made%20by-sumin-blueviolet?style=social&logo=github' align='left' width= 100%/> | ์ด๋ฒˆ ์„œ๋น„์Šค์˜ ์ฃผ์š” ๊ธฐ๋Šฅ์œผ๋กœ์„œ, ๋น ๋ฅธ ์‘๋‹ต ์‹œ๊ฐ„๊ณผ ๋ถ€ํ•˜ ๋‚ด๊ตฌ๋„๋ฅผ ๋†’์ด๊ธฐ ์œ„ํ•ด ๋…ธ๋ ฅํ–ˆ์Šต๋‹ˆ๋‹ค. |



### 1๏ธโƒฃ ์˜๋ขฐ์ธ ์šฉ API

| # | ๊ธฐ๋Šฅ ์ด๋ฆ„ | ์„ค๋ช… | ๋งํฌ |
| ---- | --------------------- | ------------------------------------------------------------ | ---- |
| 1 | ์‹œ์ผœ์•ผ ํ•  ์ผ ๋“ฑ๋ก | ํ•ด๊ฒฐ์‚ฌ๊ฐ€ ์‹œํ‚ฌ ์ผ์„ ๋“ฑ๋กํ•ฉ๋‹ˆ๋‹ค. | |
| 2 | ๊ทผ์ฒ˜ ํ•ด๊ฒฐ์‚ฌ ํ™•์ธ | ์˜๋ขฐ์ธ์˜ ํ˜„ ์œ„์น˜ ๊ธฐ๋ฐ˜ ์ฃผ๋ณ€ ํ•ด๊ฒฐ์‚ฌ๋ฅผ ์ฐพ์Šต๋‹ˆ๋‹ค. | |
| 3 | ์‹ ์ฒญ์ž ๋ฆฌ์ŠคํŠธ ํ™•์ธ | ๋“ฑ๋กํ•œ ์ผ์— ๋Œ€ํ•ด ์‹ ์ฒญํ•œ ํ•ด๊ฒฐ์‚ฌ์˜ ๋ฆฌ์ŠคํŠธ๋ฅผ ๋ฐ˜ํ™˜ํ•ฉ๋‹ˆ๋‹ค. | |
| 4 | ๋ชจ๋“  ์ผ ํ˜„ํ™ฉ ๋ณด๊ธฐ | ์ž์‹ ์ด ๋“ฑ๋กํ–ˆ๋˜ ์ผ๋“ค์˜ ์ง„ํ–‰ ํ˜„ํ™ฉ์„ ๋ณผ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. | |
| 5 | ์ผ ์ œ์•ˆํ•˜๊ธฐ | ์ผ์„ ๋งก๊ธฐ๊ณ  ์‹ถ์€ ํ•ด๊ฒฐ์‚ฌ์—๊ฒŒ ์ผ์„ ์ œ์•ˆ ํ•ฉ๋‹ˆ๋‹ค. (์š”์ฒญ, ํ™•์ • ์•„๋‹˜) | |
| 6 | ์ผ ๋งก๊ธฐ๊ธฐ | ์ผ ํ•ด๊ฒฐ์„ ์‹ ์ฒญํ•œ ํ•ด๊ฒฐ์‚ฌ ์ค‘์— 1์ธ์„ ๊ณจ๋ผ ์ผ์„ ๋งก๊น๋‹ˆ๋‹ค. | |
| 7 | No show ์˜๋ขฐ ์ฒ ํšŒ | ์ผ์„ ๋งก๊ฒผ์œผ๋‚˜, **NO SHOW**ํ•œ ํ•ด๊ฒฐ์‚ฌ์— ๋Œ€ํ•œ ์ผ ์ฒ ํšŒ๋ฅผ ์—…์ฒด ์ธก์— ์š”์ฒญํ•ฉ๋‹ˆ๋‹ค. | |
| 8 | ์ผ ์ฒ˜๋ฆฌ ์ƒ์„ธ ํ™•์ธ | ์ผ ์ฒ˜๋ฆฌ ์ง„ํ–‰์ƒํ™ฉ์„ ์‹ค์‹œ๊ฐ„์œผ๋กœ ํ™•์ธ ํ•ฉ๋‹ˆ๋‹ค. | |
| 9 | ํ•ด๊ฒฐ ํ™•์ • ํ˜น์€ ๋ฐ˜๋ ค | ์˜๋ขฐ์ธ์˜ ์ผ ํ•ด๊ฒฐ ์•Œ๋ฆผ์„ ๊ทธ๋Œ€๋กœ ์Šน๋‚™ํ•˜์—ฌ ํ™•์ • ์ง€์„ ๊ฒƒ์ธ์ง€, ๊ฑฐ์ ˆํ•˜์—ฌ ์ถ”๊ฐ€์ ์ธ ์ผ์„ ๋” ์‹œํ‚ฌ ๊ฒƒ์ธ์ง€ ์„ ํƒํ•ฉ๋‹ˆ๋‹ค. | |
| 10 | ํ•ด๊ฒฐ์‚ฌ ์œ„์น˜ ์ •๋ณด ๊ตฌ๋… | ์‹ค์‹œ๊ฐ„์œผ๋กœ ๋ณด๋‚ด์˜ค๋Š” ํ•ด๊ฒฐ์‚ฌ์˜ ์œ„์น˜๋ฅผ ๊ตฌ๋…ํ•ฉ๋‹ˆ๋‹ค. | |

### 2๏ธโƒฃ ํ•ด๊ฒฐ์‚ฌ ์šฉ API

| # | ๊ธฐ๋Šฅ ์ด๋ฆ„ | ์„ค๋ช… | ๋งํฌ |
| ---- | ----------------------- | ------------------------------------------------------------ | ---- |
| 1 | ๊ตฌ์ง์ž ๋“ฑ๋ก | ํšŒ์›์ด ์ผ์„ ํ•  ์ˆ˜ ์žˆ๋Š” ํ•ด๊ฒฐ์‚ฌ๋กœ์„œ ์ž์‹ ์„ ๋“ฑ๋กํ•ฉ๋‹ˆ๋‹ค. | |
| 2 | ๊ทผ์ฒ˜ ์ผ ๋ฆฌ์ŠคํŠธ ํ™•์ธ | ํ•ด๊ฒฐ์‚ฌ์˜ ์‹ค์‹œ๊ฐ„ ์œ„์น˜๋ฅผ ์ค‘์‹ฌ์œผ๋กœ ๋ฐ˜๊ฒฝ ์ตœ๋Œ€ 3KM ์ด๋‚ด์˜ ์ผ๊ฑฐ๋ฆฌ๋ฅผ ํ™•์ธํ•ฉ๋‹ˆ๋‹ค. | |
| 3 | ์ผ ํ•˜๋‚˜ ์ƒ์„ธ ํ™•์ธ | ํ™•์ธํ•œ ์ผ ๋ฆฌ์ŠคํŠธ ์ค‘ ํ•˜๋‚˜์˜ ์ •๋ณด๋ฅผ ์ƒ์„ธ ํ™•์ธ ํ•ฉ๋‹ˆ๋‹ค. (from no2) | |
| 4 | ์ œ์•ˆ ์Šน๋‚™ ํ˜น์€ ๊ฑฐ์ ˆ | ์˜๋ขฐ์ธ์˜ ์ผ ํ•ด๊ฒฐ ์ œ์•ˆ์„ ์Šน๋‚™ ํ˜น์€ ๊ฑฐ์ ˆ ํ•ฉ๋‹ˆ๋‹ค. | |
| 5 | ์ผ ํ•ด๊ฒฐ ์‹ ์ฒญ | ์˜๋ขฐ์ธ์—๊ฒŒ ์ผ ํ•ด๊ฒฐ์„ ์‹ ์ฒญํ•ฉ๋‹ˆ๋‹ค. | |
| 6 | ์ผ ํ•ด๊ฒฐ ์‹œ์ž‘ | ์˜๋ขฐ์ธ์ด ํ•ด๊ฒฐ์„ ์Šน๋‚™ํ•œ ์ผ๊ฑฐ๋ฆฌ ์ค‘ ํ•˜๋‚˜๋ฅผ ์‹œ์ž‘ํ•ฉ๋‹ˆ๋‹ค. | |
| 7 | ์ผ ์žฌ๊ฐœ ์‘๋‹ต | NO SHOWํ•œ ํ•ด๊ฒฐ์‚ฌ์— ํ•œํ•œ API ์ž…๋‹ˆ๋‹ค. 10๋ถ„ ๋‚ด๋กœ ํ•ด๋‹น API๋กœ ์š”์ฒญ์ด ์˜ค๋ฉด, ์ผ ์ฒ ํšŒ๊ฐ€ ์ทจ์†Œ๋˜๋ฉฐ, ์ผ์„ ์žฌ๊ฐœํ•ฉ๋‹ˆ๋‹ค. | |
| 8 | ๋ฏธ์…˜ ์‚ฌ์ง„ ์—…๋กœ๋“œ | ์ผ ํ•ด๊ฒฐ ์ธ์ฆ ์‚ฌ์ง„์„ ์—…๋กœ๋“œ ํ•ฉ๋‹ˆ๋‹ค. | |
| 9 | ๋ฏธ์…˜ ์„ฑ๊ณต ํ˜น์€ ์žฌ์‹œ๋„ | ๋ฏธ์…˜์„ ์™„๋ฃŒํ–ˆ๋‹ค ํŒ๋‹จํ•  ์‹œ ํ•ด๊ฒฐ์‚ฌ๊ฐ€ ๋ˆ„๋ฅด๋Š” ๋ฒ„ํŠผ ์šฉ API ์ž…๋‹ˆ๋‹ค. ์ด์— ๋”ฐ๋ผ ์˜๋ขฐ์ž๋Š” ์ผ ํ•ด๊ฒฐ์„ ํ™•์ •ํ• ์ง€ ์•„๋‹ˆ๋ฉด ๋ฐ˜๋ คํ• ์ง€ ๊ณ ๋ฆ…๋‹ˆ๋‹ค. | |
| 10 | ํ•ด๊ฒฐ์‚ฌ์˜ ์œ„์น˜ ์ •๋ณด ๋ฐœํ–‰ | ์ •ํ•ด์ง„ TOPIC์œผ๋กœ ํ•ด๊ฒฐ์‚ฌ๊ฐ€ ์ž์‹ ์˜ ์œ„์น˜ ์ •๋ณด๋ฅผ ๋ฐœํ–‰ํ•ฉ๋‹ˆ๋‹ค. | |



## โฐ ์•Œ๋ฆผ ์„œ๋น„์Šค

### ๐Ÿ‘จ๐Ÿปโ€๐Ÿ’ผ ๋‹ด๋‹น์ž

| <img src="https://github.com/dalcheonroadhead.png" width="100px" style="border-radius: 50%;" alt="dalcheonroadhead" align = 'center'/> | ๋‹ด๋‹น์ž ํ•œ๋งˆ๋”” |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| ![img](https://img.shields.io/badge/made%20by-sumin-blueviolet?style=social&logo=github) | ์ฃผ์š” ์„œ๋น„์Šค์ธ ๋งค์นญ์—์„œ ๋ชจ๋“  ์‚ฌ์šฉ์ž์˜ ์ƒํ˜ธ์ž‘์šฉ์ด ์•Œ๋ฆผ์œผ๋กœ ์ด๋ฃจ์–ด์ง€๋‹ค ๋ณด๋‹ˆ, ๊ฐ•๊ฒฐํ•ฉ ๋ฐฉ์ง€์™€ ๊ด€์‹ฌ์‚ฌ ๋ถ„๋ฆฌ์— ์ง‘์ค‘ํ•˜์˜€์Šต๋‹ˆ๋‹ค. |

## (1) PRD (Product Requirement Document)

## (2) API SPECIFICATION

## (3) ERD
### 1๏ธโƒฃ ์•Œ๋ฆผ API

| # | ๊ธฐ๋Šฅ ์ด๋ฆ„ | ์„ค๋ช… | ๋งํฌ |
| ---- | --------------- | ------------------------------------------------------------ | ---- |
| 1 | FCM ์•Œ๋ฆผ ์„œ๋น„์Šค | ์„œ๋น„์Šค ๋‚ด์— ๋งค์นญ ๊ด€๋ จ ์ด๋ฒคํŠธ ๋ฐœ์ƒ ์‹œ ์•Œ๋ฆผ์ด ์ž๋™ ๋ฐœ์†ก๋˜๋„๋ก ์„œ๋น„์Šค๋ฅผ ํ•จ์ˆ˜ํ™” ํ–ˆ์Šต๋‹ˆ๋‹ค. | |
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ public interface WorkerQueryMapperV1 {
NearByJobResponse toNearByJobResponse(Job job);

default List<NearByJobResponse> toNearByJobResponseList(List<Job> jobs, Location location) {
return jobs.stream()
return jobs.parallelStream()
.map(job -> {
NearByJobResponse response = toNearByJobResponse(job);
double distance = DistanceCalculateUtilDocs.calculateHaversineDistance(location.lat(), location.lng(), job.getLat(), job.getLng());
Expand Down
Loading