API 문서 정리 후 떠오른 생각

| 2019년 11월 29일 | 0 Comments

안녕하십니까 컨텐츠 서비스팀 김동형입니다

 

API 문서 수정에 대해 검색하면 어떠한 툴을 사용한다 어떤 형식으로 정리한다던가는 검색되는데

소스코드 상에서 어떻게 하면 좋다던가 하는게 검색되지 않으므로 작성 해보겠습니다

 

에러코드, 해당 메세지 등을 따로 저장해 두고

에러 출력하는 함수에서 처리할때 끌어쓰고 API문서로 만들 때 끌어쓰면 좋을 것으로 생각됩니다

API나 에러코드 이외 코드의 정리가 필요할때도 마찬가지로 사용가능합니다

 

error_collection.php

<?php

// ‘에러코드’ => ‘출력할 에러 메세지’

/* 에러코드 정의 (임의 예시)

app12 – app = 패키지명 , 1 = 분류1 , 2 = 분류2

 

분류1

1 – DB

2 – 파라미터

3 – 권한

 

*/

return $error_collection = array(

          ‘app11’=>’DB 결과 없음’,

          ‘app21’=>’파라미터 값 없음’,

          ‘app22’=>’파라미터 타입 안맞음’,

           ‘app31’=>’권한없음’,

           ‘app32’=>’인증실패’,

           …

);

?>

———————————————————————————————

proc.php

<?php

function 에러출력($code){

           $error_collection = include ‘error_collection.php’;

           if(!$error_collection[$code])

                   exit(‘에러코드가 정의되어있지 않습니다. 에러코드를 정의해야 합니다’);

          else

                   exit(json_encode(array($code,$error_collection[$code])));

}

?>

———————————————————————————————

api_document.php

//html 태그 생략

                              테이블

  (col)      에러코드 | 에러메세지 

<?php

            foreach(include ‘error_collection’ as $k => $v)

 (row)           $k       |         $v

?>

추가설명 등

———————————————————————————————

 

제목이 제목인 이유는

여기저기 파일에서 에러출력 하는데

같은 에러메세지인데도 각각 다 찾아서 수정하기도 하고 API 문서도 수정하고

(특히 기능 추가, 수정, 삭제 후) API 문서에 없는데 출력에는 있거나 반대 상황도 있어서 가면 갈수록 불행해지기 전에

한번 정리 해놔야 겠습니다

Category: 솔루션/IT기타

About the Author ()

컨텐츠 서비스팀