Skip to content

Commit 78c145b

Browse files
authored
Merge pull request #13 from OptiMaps/feat/add-collabo-docs
[FEAT] 협업을 위한 문서 작성
2 parents d02f940 + 56ff1b8 commit 78c145b

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @falconlee236 @camellia785 @KSW-KSM @muk-jjang

.github/PULL_REQUEST_TEMPLATE.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Summary
2+
3+
PR에 대한 간단한 요약을 작성합니다.
4+
5+
# Description
6+
7+
- PR에서 어떤 사항을 다루었는지에 대한 내용을 리스트로 작성합니다.
8+
- UI에 대한 사항이라면 스크린샷을, 코드에 대한 사항이라면 코드블럭을 첨부해도 좋습니다.
9+
10+
---
11+
12+
### Example (Please Delete when Open Issue)
13+
14+
> ## Summary
15+
>
16+
> Back-End의 도서검색 관련 API를 구성하였습니다.
17+
>
18+
> ## Description
19+
>
20+
> - 이후 타 API 작업 시, `Firebase` 관련 연동의 편의를 위해 `FirebaseUtil`을 구성하였습니다. 이는 Client에게 전달되지 않는 Server 항목으로, 기존에 타 프로젝트에서 활용했던 자료를 기반으로 구현하였습니다.
21+
> - 국방도서관 자료검색을 구현하였습니다. `/api/book/getMilLibraryBook/키워드`의 형태로 `GET` 요청을 전송하면, 해당 키워드가 제목에 속한 도서의 정보 리스트가 반환됩니다. 이 과정에서, `Firebase Query`를 활용하고자 하였으나, `String` 자료형에서의 `Contain`을 검사하는 `Query`가 불가한 관계로, Back-End 코드상에서 구현하였습니다.
22+
> - 네이버 도서검색을 구현하였습니다. `/api/book/getNaverBook/키워드`의 형태로 `GET` 요청을 전송하면, 해당 키워드가 제목에 속한 도서의 정보 리스트가 반환됩니다.
23+
> - 각 두 함수의 응답 형식은 다음과 같습니다.
24+
>
25+
> ```json
26+
> {
27+
> "RESULT_CODE": 200,
28+
> "RESULT_MSG": "Success",
29+
> "RESULT_DATA": {
30+
> "data": [
31+
> {
32+
> "author": "길벗R&D",
33+
> "publisher": "길벗",
34+
> "title": "2023 시나공 워드프로세서 실기 (자동 채점 프로그램)"
35+
> },
36+
> {
37+
> "author": "길벗R&D",
38+
> "publisher": "길벗",
39+
> "title": "2023 시나공 워드프로세서 실기 (자동 채점 프로그램)"
40+
> }
41+
> ]
42+
> }
43+
> }
44+
> ```

0 commit comments

Comments
 (0)