itdoc 시작하기

itdoc은 자체 인터페이스를 기반으로 jest, mocha.js 기반의 테스트코드, oas, markdown, redocli-html 문서를 자동으로 생성할 수 있게 도와주는 경량 라이브러리입니다. 테스트 기반 개발(TDD)을 하면서 자연스럽게 API 문서도 함께 작성하고 싶은 개발자에게 이상적입니다.

설치

1. Node.js 20이 설치되어 있어야 합니다.

pnpm

pnpm install itdoc --save-dev

yarn

yarn add -D itdoc

npm

npm install itdoc --save-dev

---

테스트 작성 예제

JavaScript

describeAPI(
    HttpMethod.POST,
    "/signup",
    {
        summary: "회원가입 API",
        tag: "Auth",
        description: "사용자로 부터 아이디와 패스워드를 받아 회원가입을 수행합니다.",
    },
    targetApp,
    (apiDoc) => {
        itdoc("회원가입 성공", () => {
            return apiDoc
                .test()
                .req()
                .body({
                    username: field("아이디", "penekhun"),
                    password: field("패스워드", "P@ssw0rd123!@#"),
                })
                .res()
                .status(HttpStatus.CREATED)
        })
    },
)

TypeScript

import { describeAPI, itdoc, field, HttpMethod, HttpStatus } from 'itdoc';

describeAPI(
    HttpMethod.POST,
    "/signup",
    {
        summary: "회원가입 API",
        tag: "Auth",
        description: "사용자로 부터 아이디와 패스워드를 받아 회원가입을 수행합니다.",
    },
    targetApp as Express,
    (apiDoc) => {
        itdoc("회원가입 성공", () => {
            return apiDoc
                .test()
                .req()
                .body({
                    username: field("아이디", "penekhun"),
                    password: field("패스워드", "P@ssw0rd123!@#"),
                })
                .res()
                .status(HttpStatus.CREATED)
        })
    },
);

개요

itdoc은 테스트 자동화 및 API 문서 생성을 위해 설계된 라이브러리입니다. 주요 기능은 다음과 같습니다:

• 도메인 특화 언어 (DSL): 테스트 케이스와 API 동작을 선언적으로 설명하기 위한 인터페이스를 제공합니다.
• 빌더 패턴: RootBuilder, RequestBuilder, ResponseBuilder와 같은 다양한 빌더 클래스를 제공하여 테스트 케이스를 구성합니다.
• 다중 테스트 프레임워크 지원: Mocha 및 Jest와 같은 다양한 테스트 프레임워크를 수용하기 위한 어댑터 (MochaAdapter, JestAdapter)를 포함합니다.
• HTTP 관련 상수: HTTP 메서드 및 상태 코드를 관리하기 위한 열거형 (HttpMethod, HttpStatus)을 제공합니다.

더 자세한 예제는 GitHub repository에서 확인할 수 있습니다.

다음 단계