swagger:

index.html

User

• role은 이후에 개발, 기본으로 guest로 저장 | | 로그인 | POST | /api/user/login | Content-Type: application/json | json {"email": "string", "password": "string"} | - 성공 (200 OK): - 응답 본문: json {"message": "로그인 성공", "data": { "nickname": "string", "email": "string", "birth_date": "YYYY-MM-DD", "profile_color": "string"}} Set-Cookie: token=<JWT 토큰>; HttpOnly; Secure; Path=/; | 401 Unauthorized: json {"error": "잘못된 이메일 또는 비밀번호"} | 로그인 시 프로필 정보를 함께 전달합니다. | | 닉네임 수정 | PATCH | /api/user | Content-Type: application/json Authorization: Bearer <JWT 토큰> | json {"nickname": "string"} | - 성공 (200 OK): json {"message": "닉네임 수정 성공", "data": {"nickname": "string"}} | 400 Bad Request: json {"error": "필수 필드 누락"} 404 Not Found: json {"error": "유효하지 않은 user_id"} | 이메일 수정 불가, 닉네임 수정 가능 | | 비밀번호 변경 | PATCH | /api/user/password | Content-Type: application/json Authorization: Bearer <JWT 토큰> | json {"current_password": "string", "new_password": "string"} | - 성공 (200 OK): json {"message": "비밀번호 변경 성공"} | 400 Bad Request: json {"error": "필수 필드 누락"} 401 Unauthorized: json {"error": "현재 비밀번호가 일치하지 않습니다"} | 현재 비밀번호가 일치하는 경우에만 새 비밀번호로 변경 가능 | | 회원 탈퇴 | DELETE | /api/user | Authorization: Bearer <JWT 토큰> | json {"password": "string"} | - 성공 (200 OK): json {"message": "회원 탈퇴 성공"} | 400 Bad Request: json {"error": "필수 필드 누락"} 404 Not Found: json {"error": "유효하지 않은 user_id"} 401 Unauthorized: json {"error": "비밀번호가 일치하지 않습니다"} | 사용자의 모든 데이터가 삭제됩니다. |
• 프로필 컬러코드

수정사항

Stock API 명세서

종목 정렬 조회는 stockprice 도메인에서 |

수정 사항

• 종목 검색 자동완성 api
• 거래대금 순, 등락율 순, 거래량 순 정렬 10개씩 페이징 처리 최대 10페이지
  • 최근 본 종목 리스트 body에 stockId 리스트로 받아서 현재가 조회 API 추가

Announcement API 명세서

"message": "특정 주식 공시 목록 조회 성공",
"data": {
    "announcementCount": 1,
    "announcementList": [
        {
            "announcementId": 1,
            "title": "일괄신고추가서류(파생결합사채-주가연계파생결합사채)",
            "stockName": "NH투자증권",
            "announcementDate": "2024-11-20",
            "submitter": "NH투자증권",
            "totalVoteCount": 0,
            "positiveVoteCount": 0,
            "negativeVoteCount": 0,
            "commentCount": 7
        }
    ]
}

}| **404 Not Found**:json {"error": "유효하지 않은 stock_id"}| 특정 주식에 대한 공시 목록을 페이징하여 조회합니다. | | 검색어 공시 목록 조회 | GET |/api/announcement/search| 없음 |keyword(default:"", page(deafault:0), size(deafault:10), "period"(default:"") : { 1m, 6m, 1y, 3y, yyyy-mm-dd~yyyy-mm-dd}, marketType(default:"") : { "KOSPI", "KOSDAQ"}, type(default:"") : {정기공시, 주요사항보고, 외부감사관련, 발행공시, 지분공시, 자산유동화, 거래소공시, 타공시, 공정위공시}| 없음 |json { "message": "검색어 주식 공시 목록 조회 성공", "data": { "announcementCount": 1, "announcementList": [ { "announcementId": 1, "title": "일괄신고추가서류(파생결합사채-주가연계파생결합사채)", "stockName": "NH투자증권", "announcementDate": "2024-11-20", "submitter": "NH투자증권", "totalVoteCount": 0, "positiveVoteCount": 0, "negativeVoteCount": 0, "commentCount": 7 } ] } }` | | keyword 검색어에 대해 LIKE 문을 사용하여 announcement들 중 keword가 stockName에 포함되는 모든 공시를 페이지네이션 조회하는데 기본 size는 10이며, 이때 최신순, 투표수 순, 댓글 많은 순으로 정렬할 수 있으며, 또한 period로 최근 1달, 최근 6달, 최근 1년, 최근 3년 혹은 특정 날짜를 yyyy-mm-dd ~ yyyy-mm-dd 로 설정하여 검색할 수 있으며 공시에 연관된 stock의 마켓 타입도 설정할 수 있으며 기본값은 전부이다. 그리고 공시의 type으로도 검색 조건을 설정할 수 있다. |

수정 사항

• 공시 최신순, 조회수, 댓글순, 투표순으로 요청하는 api page랑 sort_by 요청 파라미터로 받아야 해

Comment API 명세서