코드이그나이터3 (CI3) + Rest full api + api docs

1. PHP 5.3.7 보다 크고 7.5 보다 낮게 설정 권장 (chriskacerguis/codeigniter-restserver 3.1.5 사용중)

2. 사용된 프레임워크 : CI 3.1.12, 

3. 깃허브 주소: https://github.com/antam2010/ait  (현재 private)

 

사용방법 : 

- composer install 해서 라이브러리 설치

- vendor 디렉토리는 third_party 하위에 생성되도록 해놓았음

"config": {

        "vendor-dir": "application/third_party/vendor"

    },

 

- node 설치 후 글로벌로 apidoc 설치

- 해당 명령어는 주석으로 api-doc 문서 작성이나 수정하고 실행하면 됨

npm install -g apidoc

 

실서버 api-doc 생성일경우 :  apidoc -i application/controllers/ -o docs --config apidoc.prod.json --verbose
로컬 api-doc 생성일경우 :  apidoc -i application/controllers/ -o docs --config apidoc.local.json --verbose

 

4. 외부 API 사용법

- 모델에 해당 코드처럼 사용하면 됨

- require 하는이유는 밑처럼 subclass_prefix 를 MY 로 해두었지만 MY_Input, MY_Model 처럼 사용해야 자동으로 로드되됨

$config['subclass_prefix'] = 'MY_';

require_once APPPATH . 'core/MY_api_Model.php';

class model_name  extends MY_api_Model {

 

 - config/config.php 맨 하단에

$config['ai_api_domain'] = 외부api 주소

 

설정 후에 사용 하면 됨

 

5. 내부 모델은 core/MY_model.php 만들어놓았으니 extends 해서 사용

- class model_name  extends MY_Model {