...
| Code Block | ||
|---|---|---|
| ||
mkdir -p appsrc/Api/v1 |
API 를 문서화할 파일(예: appsrc/Api/v1/AwesomeApi.phpjs) 를 만들어서 다음 내용을 넣어줍니다.
| Code Block | ||
|---|---|---|
| ||
<?php
/**
* @api {get} /user/:id Request User information
*
* @apiVersion 1.0.0
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/ |
...
| Code Block | ||
|---|---|---|
| ||
apidoc -i appsrc/ -o public/apidoc |
이제 public/apidoc 이라는 폴더에 static html 파일이 생성되었으므로 serve 를 사용해서 웹 서버를 띄우고 브라우저로 접속하면 됩니다.
| Code Block |
|---|
serve public/apidoc |
확장자 지정
특정 확장자를 가진 파일만 문서화할 경우 -f 로 파일의 확장자를 정규식으로 지정해 줍니다.
아래는 .php 파일만 js파일만 스캔해서 문서화하는 예제입니다.
| Code Block | ||
|---|---|---|
| ||
apidoc -i app/ -f ".*\.php$js$" -o public/apidoc |
템플릿 사용
템플릿을 별도로 사용하려면 -t 옵션으로 템플릿을 지정할 수 있습니다.
...