ngDoc - API

Angular 애플리케이션에서 API 문서 생성하기

Angular 애플리케이션에서 API 문서를 자동으로 생성하는 방법에 대해 설명드리겠습니다. 이를 위해서 @ng-doc/builder와 @ng-doc/core를 사용하여 API 문서를 생성할 수 있습니다.

1. 설치

먼저, @ng-doc/builder를 사용하여 API 문서를 생성하기 위해 다음 명령어로 패키지를 설치합니다.

ng add @ng-doc/builder

2. 모델 파일 작성

API 문서에 포함시킬 모델 파일을 작성합니다. 예를 들어 sample.model.ts 파일을 생성하고 다음과 같이 내용을 작성합니다.

export interface ISample {
  key: string;
  value: string;
}

export interface ISam {
  key: string;
  value: string;
}

export enum TEST {
  NONE = 0,
  ONE = 1,
  TWO = 2
}

export type TType = {
  key: string;
  value: string;
}

3. API 설정 파일 작성

API 문서를 생성하기 위해 API 설정 파일(ng-doc.api.ts)을 작성합니다. 이 설정 파일은 @ng-doc/core에서 사용됩니다.

import { NgDocApi } from '@ng-doc/core';
import GettingStartedCategory from './getting-started/ng-doc.category';

const Api: NgDocApi = {
  title: 'API Documentation',
  category: GettingStartedCategory,
  scopes: [
    {
      name: 'example-library', // 스코프 이름
      route: 'examlibrary', // 라우트 경로
      include: 'src/app/sample.model.ts', // 포함할 모델 파일 경로
    },
  ],
};

export default Api;

위 설정에서 scopes 배열에는 포함시키고자 하는 모델 파일의 경로와 다른 정보들을 설정합니다.

4. API 문서 생성

API 설정 파일을 작성하고 설정을 완료했다면 다음 명령어를 실행하여 API 문서를 생성합니다.

ng generate @ng-doc/builder:api

5. 확인

API 문서가 생성되면, Angular 애플리케이션에서 문서를 확인할 수 있습니다. 예를 들어 브라우저에서 http://localhost:4200/api/examlibrary로 접속하면 API 문서를 볼 수 있습니다.

API 문서에는 작성한 모델 파일과 관련된 정보가 자동으로 나열됩니다. 또한, 이와 같은 방식으로 인터페이스 외에도 서비스나 컴포넌트 등 다양한 요소를 문서화할 수 있습니다.

이를 통해 Angular 애플리케이션의 API 문서를 효과적으로 관리하고 개발자들에게 제공할 수 있습니다.