FC-DEV-FinalProject / final-fe-team4

4조 프론트엔드 깃허브
0 stars 2 forks source link

[feat] 샘플 API 재생성 #251

Closed nakyeonko3 closed 18 hours ago

nakyeonko3 commented 20 hours ago

Sourcery에 의한 요약

레거시 함수를 별도의 파일로 이동하고 업데이트된 함수로 새로운 샘플 API를 도입하여 API 구조를 재구성합니다. 이러한 변경 사항을 반영하기 위해 빌드 구성을 업데이트합니다.

새로운 기능:

개선 사항:

빌드:

Original summary in English ## Summary by Sourcery Reorganize the API structure by moving legacy functions to a separate file and introducing a new sample API with updated functions. Update the build configuration to reflect these changes. New Features: - Introduce a new sample API by creating a new file 'api-sample-new/aiParkAPI.ts' with updated API functions. Enhancements: - Move existing API functions to 'aiParkAPI_legacy.ts' to separate legacy code from the new implementation. Build: - Update the build configuration to target the new API directory 'src/api-sample-new' and use a new axios client 'axios-client-new.ts'.
sourcery-ai[bot] commented 20 hours ago

리뷰어 가이드 by Sourcery

이 PR은 기존 API 기능을 별도의 파일로 이동하고 새로운 샘플 API 기능을 새로운 디렉토리에 생성하여 API 파일을 재구성합니다. 변경 사항에는 파일 이름 변경, 함수 재배치, API 구성 업데이트가 포함됩니다.

업데이트된 API 구조의 클래스 다이어그램

classDiagram
    class aiParkAPI_legacy {
        - ProcessVCProjectBody
        - ProcessVCProjectParams
        - processVCProject()
        - concatSave()
        - concatLoad()
    }
    class aiParkAPI {
        + updatePassword()
        + updateMemberInfo()
        + saveVCProject()
        + processVCProject()
        + ttsSave()
        + convertBatchTexts()
        + uploadUnit()
        + uploadUnit1()
        + uploadFiles()
        + uploadFiles1()
        + uploadConcat()
        + signUp()
        + logout()
        + login()
        + getMemberInfo()
        + findPassword()
        + findId()
        + checkEmailDuplicate()
        + concatSave()
        + deleteConcatProject()
        + deleteConcatDetails()
        + convertMultipleAudios()
        + getProjects()
        + getRecentProjects()
        + getExports2()
        + getRecentExports()
        + getProjects1()
        + getExports()
        + voice()
        + vcLoad()
        + trgAudioLoad()
        + ttsLoad()
        + testSuccess()
        + testFail()
        + downloadGeneratedAudio()
        + downloadGeneratedAudio1()
        + downloadGeneratedAudio2()
        + downloadGeneratedAudio3()
        + downloadGeneratedAudio4()
        + concatLoad()
        + start()
        + deleteProjects()
        + deleteExports()
        + deleteVCProject()
        + deleteTRGAudio()
        + deleteVCDetail()
        + deleteTTSProject()
        + deleteTTSDetails()
        + deleteOutputAudioMetaByS3()
        + deleteMemberAudio()
    }
    class concatAPI {
        + concatLoad()
        + concatSave()
    }
    aiParkAPI_legacy <|-- aiParkAPI
    aiParkAPI <|-- concatAPI
    note for aiParkAPI "새로운 샘플 API 기능"
    note for aiParkAPI_legacy "기존 API 기능이 이곳으로 이동됨"

파일 수준 변경 사항

변경 사항 세부 사항 파일
기존 및 새로운 샘플 API를 분리하여 API 파일 구조 재구성
  • 기존 aiParkAPI.ts를 aiParkAPI_legacy.ts로 이름 변경
  • api-sample-new 디렉토리에 새로운 API 파일 생성
  • 기존 API 기능을 aiParkAPI_legacy.ts로 이동
  • concat 관련 기능을 위한 새로운 concatAPI.ts 파일 생성
src/api/aIParkAPI.ts
src/api-sample-new/aIParkAPI_legacy.ts
src/api/concatAPI.ts
src/api-sample-new/aIParkAPI.ts
API 생성 구성 업데이트
  • 대상 디렉토리 경로를 api-sample-new로 수정
  • axios 클라이언트 경로 참조 업데이트
orval.config.cjs
새로운 API 타입 정의 및 스키마 추가
  • API 타입을 위한 새로운 스키마 파일 생성
  • 요청/응답 DTO에 대한 포괄적인 타입 정의 추가
src/api-sample-new/aIParkAPI.schemas.ts

팁 및 명령어 #### Sourcery와 상호작용하기 - **새로운 리뷰 트리거:** PR에 `@sourcery-ai review`라고 댓글을 남깁니다. - **토론 계속하기:** Sourcery의 리뷰 댓글에 직접 답글을 남깁니다. - **리뷰 댓글에서 GitHub 이슈 생성:** 리뷰 댓글에 답글을 달아 Sourcery에게 이슈 생성을 요청합니다. - **PR 제목 생성:** PR 제목 어디에나 `@sourcery-ai`를 작성하여 언제든지 제목을 생성합니다. - **PR 요약 생성:** PR 본문 어디에나 `@sourcery-ai summary`를 작성하여 언제든지 PR 요약을 생성합니다. 이 명령어를 사용하여 요약이 삽입될 위치를 지정할 수도 있습니다. #### 경험 맞춤화 [대시보드](https://app.sourcery.ai)에 접속하여: - Sourcery가 생성한 PR 요약, 리뷰어 가이드 등과 같은 리뷰 기능을 활성화하거나 비활성화합니다. - 리뷰 언어를 변경합니다. - 사용자 정의 리뷰 지침을 추가, 제거 또는 편집합니다. - 기타 리뷰 설정을 조정합니다. #### 도움 받기 - 질문이나 피드백이 있을 경우 [지원팀에 문의](mailto:support@sourcery.ai)하세요. - 자세한 가이드와 정보를 보려면 [문서](https://docs.sourcery.ai)를 방문하세요. - [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/), [GitHub](https://github.com/sourcery-ai)에서 Sourcery 팀을 팔로우하여 소식을 받아보세요.
Original review guide in English ## Reviewer's Guide by Sourcery This PR reorganizes the API files by moving legacy API functions to a separate file and creating new sample API functions in a new directory. The changes include file renaming, function relocations, and updates to API configurations. #### Class diagram for updated API structure ```mermaid classDiagram class aiParkAPI_legacy { - ProcessVCProjectBody - ProcessVCProjectParams - processVCProject() - concatSave() - concatLoad() } class aiParkAPI { + updatePassword() + updateMemberInfo() + saveVCProject() + processVCProject() + ttsSave() + convertBatchTexts() + uploadUnit() + uploadUnit1() + uploadFiles() + uploadFiles1() + uploadConcat() + signUp() + logout() + login() + getMemberInfo() + findPassword() + findId() + checkEmailDuplicate() + concatSave() + deleteConcatProject() + deleteConcatDetails() + convertMultipleAudios() + getProjects() + getRecentProjects() + getExports2() + getRecentExports() + getProjects1() + getExports() + voice() + vcLoad() + trgAudioLoad() + ttsLoad() + testSuccess() + testFail() + downloadGeneratedAudio() + downloadGeneratedAudio1() + downloadGeneratedAudio2() + downloadGeneratedAudio3() + downloadGeneratedAudio4() + concatLoad() + start() + deleteProjects() + deleteExports() + deleteVCProject() + deleteTRGAudio() + deleteVCDetail() + deleteTTSProject() + deleteTTSDetails() + deleteOutputAudioMetaByS3() + deleteMemberAudio() } class concatAPI { + concatLoad() + concatSave() } aiParkAPI_legacy <|-- aiParkAPI aiParkAPI <|-- concatAPI note for aiParkAPI "New sample API functions" note for aiParkAPI_legacy "Legacy API functions moved here" ``` ### File-Level Changes | Change | Details | Files | | ------ | ------- | ----- | | Reorganized API files structure by separating legacy and new sample APIs |
  • Renamed existing aiParkAPI.ts to aiParkAPI_legacy.ts
  • Created new API file in api-sample-new directory
  • Moved legacy API functions to aiParkAPI_legacy.ts
  • Created new concatAPI.ts file for concat-related functions
| `src/api/aIParkAPI.ts`
`src/api-sample-new/aIParkAPI_legacy.ts`
`src/api/concatAPI.ts`
`src/api-sample-new/aIParkAPI.ts` | | Updated API generation configuration |
  • Modified target directory path to api-sample-new
  • Updated axios client path reference
| `orval.config.cjs` | | Added new API type definitions and schemas |
  • Created new schema file for API types
  • Added comprehensive type definitions for request/response DTOs
| `src/api-sample-new/aIParkAPI.schemas.ts` | ---
Tips and commands #### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).
github-actions[bot] commented 20 hours ago

Visit the preview URL for this PR (updated for commit dd77224):

https://aipark-four-t--251-dtn7xevg.web.app

(expires Fri, 06 Dec 2024 07:32:55 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 0a4b3ef6ecc2c695a6a0d6ade46651e032870a9f