# DWP 1주년 이벤트 페이지 - BackEnd

## API 명세서
| # | API 제목 | Method | URI |
| --- | ---------------- | ------ | ----------------- |
| 1 | 사용자 정보 받아오기 | GET | `/api/sso` |
| 2 | 퍼즐 완성한 사람 | POST | `/api/puzzle` |
| 3 | 방명록 불러오기 | GET | `/api/board/all` |
| 4 | 방명록 입력 | POST | `/api/board/create` |
| 5 | 방명록 삭제 | POST | `/api/board/delete` |

1. 사용자 정보 받아오기 (GET)
- SSO 인증된 사용자 정보 받아오기
- URI: `/api/sso`
- response
200

        {
            "ssoCheck": true,            // sso 인증 성공, 실패 시 false -> dwp로 redirect 
            "userName": "ssotest001",
            "userEmail": "[e-mail]",
            "userCompanyName": "LDEMO2",
            "puzzleState": false,
            "boardState": false
        }

2. 퍼즐 완성한 사람 (POST)
- 퍼즐 정답을 맞춘 사람의 이메일 정보를 post하는 API
- URI: `/api/puzzle`
- request body

        {
            
        }

- response
200

        {
            "check" : true
        }

401

3. 방명록 불러오기 (GET)
- 방명록의 전체 게시글을 불러오는 API
- URI: `/api/board/all`
- parameter
- ex) `http://localhost:8083/api/boards/all'
- response
200

        {
            "boardList": [
                {
                    "id": 18,
                    "content": "hihihihihihihihihihibyebyebyebyebyebye",
                    "createDate": "2021-12-07T00:54:53.307+00:00",
                    "user": {
                        "userName": "김롯데",
                        "userEmail": "[e-mail]",
                        "userCompanyName": "LDEMO",
                    }
                },
                {
                    "id": 14,
                    "content": "안녕하세요 dwp 1주년 축하드립니다.",
                    "createDate": "2021-12-07T00:10:36.323+00:00",
                    "user": {
                        "userName": "손롯2데",
                        "userEmail": "[e-mail]",
                        "userCompanyName": "LDEMO",
                    }
                },
                {
                    "id": 1,
                    "content": "안녕하세요 dwp 1주년 축하드립니다.",
                    "createDate": "2021-12-01T22:37:37.350+00:00",
                    "user": {
                        "userName": "테스트2",
                        "userEmail": "[e-mail]",
                        "userCompanyName": "LDEMO",
                    }
                }
            ]
        }

401

4. 방명록 입력 (POST)
- 방명록 내용 입력 후 요청하는 API
- URI: `/api/board/create`
- request body

        {
            "content" : "안녕하세요 dwp 1주년 축하드립니다."
        }

- response
- 방명록 ID / 방명록 등록 성공 시 true, 실패 시 false 반환
200

        {
            "check" : true
            "id" : 12
        }

401

5. 방명록 삭제 (POST)
- 특정 방명록 내용을 삭제할 때 요청하는 API
- URI: `/api/boards/delete`
- request body

        {
            "id" : 12           // 방명록 id 
        }

- response
- 방명록 삭제 성공 시 true, 실패 시 false 반환
200

        {
            "check" : true
        }

401

## 기본 코딩 규칙
- [Google Coding Convention(Java)](https://google.github.io/styleguide/javaguide.html) 을 적용한다.