Mojo Academy · 강의

공개 API와 구조

외부에 공개할 항목을 결정합니다.

레슨 3/413개 단계

공개 API와 구조은(는) CoddyKit의 무료 Mojo Academy 강의입니다. 이것은 4개 중 3번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Mojo Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Mojo Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

무엇을 보여 주느냐가 중요합니다

좋은 라이브러리는 외부에 드러나는 부분으로 평가됩니다. 무엇을 공개할지 결정하는 방식이 API의 사용 편의성을 좌우합니다. 🚪

공개 API

다른 코드에서 호출하도록 제공하는 함수와 타입이 공개 API를 구성합니다. 공개 API는 사용자에게 지키는 약속입니다.

내부 구현은 숨기기

API를 지원하지만 호출자가 사용하도록 만든 것이 아닌 도우미 코드는 내부 구현입니다. 이를 숨기면 외부에 드러나는 부분을 작게 유지할 수 있습니다.

더 작은 외부 영역, 더 적은 위험

공개하는 이름이 적을수록 라이브러리를 배우기 쉽고, 나중에 내부 구현을 더 자유롭게 변경할 수 있습니다.

init에서 다시 내보내기

패키지의 __init__.mojo에서 핵심 이름을 가져오면 사용자가 깊숙한 파일로 들어가지 않고 패키지에서 바로 사용할 수 있습니다.

from .core import add, subtract

깔끔한 진입점

__init__에 가져오기를 모아 두면 호출자에게 길고 불안정한 모듈 경로 대신 하나의 명확한 진입점을 제공할 수 있습니다.

from mypkg import add

구조 숨기기

사용자는 파일이 아니라 패키지에서 가져옵니다. 따라서 코드를 깨뜨리지 않고 내부 모듈을 재배치할 수 있습니다.

이름을 명확하게 정하기

공개 이름은 스스로 의미를 설명할 수 있어야 합니다. 명확하고 안정적인 이름은 변경하고 싶지 않은 계약의 일부입니다.

외부 영역 문서화하기

각 공개 함수와 타입에 독스트링을 추가하세요. 좋은 문서는 호출자에게 API를 올바르게 사용하는 방법을 알려 줍니다.

fn add(a: Int, b: Int) -> Int:
    """Return the sum of a and b."""
    return a + b

안정적인 약속

공개 API를 계약으로 취급하세요. API를 변경하면 사용자의 코드가 깨질 수 있으므로 작게 유지하고 확장하기 전에 신중히 생각해야 합니다.

외부에서 내부로 설계하기

먼저 호출자가 라이브러리를 어떻게 사용하고 싶어 하는지 그려 본 다음, 그 깔끔한 경험을 지원하도록 내부 구현을 만드세요. 🎨

빠른 확인

API를 유지 관리하기 쉽게 만드는 방법을 생각해 보겠습니다.

인터랙티브 레슨에서 답해보세요

요약

작고 명확한 공개 API를 제공하고, __init__에서 핵심 이름을 다시 내보내며, 내부 구현을 숨기고, 공유하는 내용을 문서화하세요. 🎯

무료로 시작

AI 튜터와 함께 Mojo을(를) 배우세요 — 무료

브라우저에서 실제 코드를 작성하고 실행하며, 24/7 AI 튜터로부터 즉각적인 도움을 받고, 웹이나 앱에서 중단한 부분부터 계속 학습하세요.

코스: 30
레슨: 120

무료로 학습 시작 전체 코스 보기

자주 묻는 질문