▲penekhun 11달전 | parent | ★ favorite | on: Show GN: itdoc - Swagger 없이 정확한 Node.js API 문서 만들어 보세요(github.com/do-pa)아래와 같이 사람이 읽을 수 있는 코드로 문서를 생성할 수 있습니다. describeAPI( HttpMethod.GET, "/users/:userId", { summary: "사용자 조회 API", tag: "User", description: "특정 사용자의 상세 정보를 조회하는 API입니다.", }, targetApp, (apiDoc) => { itDoc("유효한 사용자 ID가 주어지면 사용자의 상세 정보가 나온다.", async () => { await apiDoc .test() .req() .pathParam({ userId: field("유효한 사용자 ID", "penek"), }) .res() .status(HttpStatus.OK) .body({ userId: field("유저 ID", "penek"), username: field("유저 이름", "hun"), email: field("유저 이메일", "penekhun@gmail.com"), friends: field("유저의 친구", ["zagabi", "json"]), }) }) ....
아래와 같이 사람이 읽을 수 있는 코드로 문서를 생성할 수 있습니다.