구문 분석 서버 응용 프로그램에서 문서를 생성하는 방법

Question

구문 분석 서버의 Powerful Express 응용 프로그램에서 우리 스키마/클래스를 기반으로 설명서를 생성 할 수 있는지 궁금합니다.

또한 특정 게시물 본문이 있어야하는 약 15 개의 클라우드 기능이 있습니다. 문서 생성기를 갖는 것이 좋습니다.

Answer 1

구문 분석기 클래스 스키마에 대한 APIDOC 생성기에 대해 잘 모릅니다. 그러나 좋은 출발점은 Schema APIs 일 수 있습니다.이를 통해 앱에서 클래스 스키마에 대한 JSON 설명을 가져올 수 있습니다. 변환 할 수있는 간단한 형식을 반환하고 원하는 문서화 도구로 피드 할 수 있습니다.

클라우드 코드 기능의 경우 자동화 된 IMO를 수행 할 수있는 방법이 없습니다. 함수의 매개 변수와 결과는 명시 적으로 정의되어 있지 않으며 함수는 일반 JavaScript 객체를 가져 와서 반환합니다 요청 매개 변수와 클라이언트가 응답을 처리 할 수 ​​있습니다. 이 문제를 해결하기 위해 클라우드 코드 함수를 일반 함수로 작성하고 많은 JS 유형 정보 시스템 중 하나를 사용하여 주석을 달거나 TypeScript를 사용하여 APIDOC 도구를 사용할 수 있습니다. 이러한 평범한 함수는 request 개체에서 함수의 입력 매개 변수로의 변환과 함수의 결과 (또는 오류)에서 response 개체로의 변환을 처리하는 간단한 래퍼를 통해 구문 분석에 노출됩니다.