Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagepowershell
# npm i -g apidoc

apidoc -i app/ -f ".*\.js" -o public/apidoc `
        -e AdminController.js `
        -e ResetPasswordController.js

if ($?) {
    serve public/apidoc
}


Linux 용 shell script 는 확장자를 정규식으로 사용하기 위해 . 을 \\. 으로 기술해야 합니다.

Code Block
languagebash
#!/usr/bin/env bash

apidoc -i app/ -f ".*\\.js$" -o public/apidoc \
        -e AdminController.js \
        -e ResetPasswordController.js

serve

if [ $? -eq 0 ]; then
    serve public/apidoc
fi


문서화

상세 사용법은 APIDoc 으로 REST API 문서화 하기 #2 참고하세요.

...

Ref