Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pr Docs/2 honeytip swagger #5

Merged
merged 7 commits into from
Jan 25, 2024
Merged

Conversation

LEEJaeHyeok97
Copy link
Contributor

@LEEJaeHyeok97 LEEJaeHyeok97 commented Jan 6, 2024

Issue number and Link

이슈 번호 : #4

Summary

  • 꿀팁 공유해요 관련 스웨거를 작성하였습니다.

PR Type

  • Feature
  • Bugfix
  • Refactoring
  • Documentation
  • Other

Other Information

Common Type

- feat : 새로운 기능 구현
- add : feat 이외의 부수적인 코드, 파일, 라이브러리 추가
- chore : 패키지 구조, 함수 및 변수명 변경 등의 작은 작업
- fix : 버그 및 오류 해결
- del : 불필요한 코드, 파일, 주석 삭제
- docs : 명세서 작성
- refactor : 코드 리팩토링
- merge : 서로 다른 브랜치 간의 코드 병합
- setting : 프로젝트 기초 세팅 관련 작업

branch

Feature/{이슈 번호 x, feat 순서}-{작업 내용}

ex)
Feature/3-home-api
Feature/4-home-crud

@LEEJaeHyeok97 LEEJaeHyeok97 added 📝 Docs 문서 수정 / 추가 작업 ✨ Feature 새로운 기능 추가 이재혁 labels Jan 6, 2024
@LEEJaeHyeok97 LEEJaeHyeok97 self-assigned this Jan 6, 2024
@psae0714
Copy link
Contributor

psae0714 commented Jan 8, 2024

확인했습니다!

Copy link
Member

@toychip toychip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

재혁님 코드 확인했습니다!
제가 말씀드린 것 참고해주시고 반영해주시면 좋겠습니다.
제가 작업 완료한 질문해요 메인 화면의 명세서 코드를 참고하시면 좋을 것 같아 남겨드립니다! 참고자료

@LEEJaeHyeok97 LEEJaeHyeok97 changed the title feat:#4 꿀팁 공유해요 관련 스웨거 작성 pr Docs/2 honeytip swagger Jan 15, 2024
@LEEJaeHyeok97 LEEJaeHyeok97 linked an issue Jan 15, 2024 that may be closed by this pull request
1 task
Copy link
Member

@toychip toychip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

재혁님 코드 확인했습니다.
저번 저의 의견 반영해주셔서 감사합니다! ☺️

package com.api.ttoklip.domain.honeytip.main.domain;

public enum Category {
HOUSEWORK, RECIPE, SAFE_LIVING, WELFARE_POLICY
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

enum을 더 의미있게 사용해보는 것은 어떨까요?
아래와 같이 사용하면 더 많은 정보들을 유연하게 활용할 수 있을 것 같습니다!

// 예시..
HOUSEWORK("집안일", 1),
    RECIPE("요리", 2),
    SAFE_LIVING("안전한 생활", 3),
    WELFARE_POLICY("복지 정책", 4);

    private final String name;
    private final int code;

    Category(String name, int code) {
        this.name = name;
        this.code = code;
    }

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AllArgsConstructor
@getter
를 사용해도 좋을 것 같아요.


public HoneytipMainRes main() {
return null;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

해당 메인의 기능이 제가 담당한 '질문해요'와 기능이 같은 것 같습니다. 그 중, 꿀팁의 메인 기능과 질문해요의 메인 기능을 합치는 ParenetMain과 같은 클래스를 만들어서 객체화하면 좋을 것 같은데 재혁님 의견이 궁금합니다.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

기능이 겹치는 부분은 합치는게 좋다고 생각합니다.

value = HoneytipResponseConstant.honeytipValue,
description = "인기 꿀팁 Top 5와 카테고리별 3개가 한번에 응답으로 나갑니다."
)))})
@GetMapping
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

제 의견 반영해주셨네요 감사합니다 ☺️

@Service
@RequiredArgsConstructor
public class HoneytipPostService {
public Long register(HoneytipCreateReq request) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

parameter에 final 키워드를 추가하여 불변성을 지키면 좋을 것 같습니다!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

final 키워드 추가하였습니다.

@toychip toychip added the 🔀 PullRequest Branch 합병 label Jan 24, 2024
@LEEJaeHyeok97 LEEJaeHyeok97 merged commit 0aa87a6 into develop Jan 25, 2024
@toychip toychip mentioned this pull request Jan 25, 2024
5 tasks
@toychip toychip deleted the Docs/2-honeytip-swagger branch October 17, 2024 07:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs 문서 수정 / 추가 작업 ✨ Feature 새로운 기능 추가 🔀 PullRequest Branch 합병 이재혁
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: 꿀팁 공유해요 명세서
3 participants