uppercase-api-generator v1.1.2

uapi

UPPERCASE 기반 프로젝트의 API 문서를 생성합니다.

설치방법

npm install uppercase-api-generator -g

사용법

uapi {{소스 폴더 경로}} {{API 문서들을 저장할 폴더 경로}} {{추가하지 않을 파일들 (선택)}}

표현식

REQUIRED와 OPTIONAL로 주로 표현됩니다.

global.CONNECT_TO_WEB_SOCKET_SERVER = METHOD({

	run : function(params, connectionListenerOrListeners) {
		'use strict';
		//REQUIRED: params
		//OPTIONAL: params.isSecure
		//OPTIONAL: params.host
		//REQUIRED: params.port
		//OPTIONAL: params.fixRequestURI
		//REQUIRED: connectionListenerOrListeners
		//REQUIRED: connectionListenerOrListeners.success
		//OPTIONAL: connectionListenerOrListeners.error
		
		...

라이센스

MIT

작성자

Young Jae Sim