타입스크립트(TypeScript)는 많은 개발자들에게 선택 사항이 되었습니다. 타입스크립트로 빌드된 애플리케이션의 인터페이스와 API를 문서화하는 것은 중요한 작업이 됩니다. 이러한 문서화 작업을 도와주는 여러가지 API 문서화 도구들이 있습니다.

이를 통해 오늘은 타입스크립트와 함께 사용할 수 있는 몇 가지 API 문서화 도구들을 살펴보겠습니다.

1. TypeDoc
   • TypeDoc은 타입스크립트에서 사용할 수 있는 강력한 API 문서화 도구 중 하나입니다.
   • 자체적으로 타입스크립트의 타입 시스템을 사용하여 자동으로 타입 정보를 추출합니다.
   • 링크를 통해 더 자세한 정보를 확인할 수 있습니다.

// TypeDoc 설정 예제
{
  "name": "my-project",
  "mode": "file",
  "out": "./docs",
  "includes": "./src",
  "exclude": ["node_modules", "dist"],
  "ignoreCompilerErrors": true
}

1. ApiExtractor
   • Microsoft에서 개발한 ApiExtractor는 TypeScript용 API 문서화 도구로, JavaScript 프로젝트에도 적용할 수 있습니다.
   • 빌드 프로세스에 통합될 수 있는 기능들을 제공하여 API를 문서화하고 공유하는 것을 간편하게 만들어줍니다.
   • 링크에서 더 많은 정보를 확인할 수 있습니다.

// ApiExtractor 설정 예제
{
  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
  "dtsRollup": {
    "enabled": true
  },
  "apiReport": {
    "enabled": true,
    "reportFolder": "<projectFolder>/temp/"
  }
}

이러한 도구들을 사용하면 타입스크립트로 작성된 코드의 API 문서를 쉽게 생성하고 유지보수할 수 있습니다. 도구 선택 시 프로젝트의 요구 사항과 팀의 선호도를 고려하여 적절한 도구를 선택하는 것이 중요합니다.