ApiDoc

소개

APIDOC는 PHP REST API 문서를 지원하기 위해 HTML, PHP 및 JQuery로 만든 템플릿입니다.

설치

아래 링크를 명령 줄에 복사하여 최신 버전을 다운로드하십시오. APIDOC는 컴퓨터에 설치할 필요가 없으며 파일을 복제하고 서버 폴더로 압축을 풀기 만하면됩니다.

$ git clone -b 2.0.0-stable --single-branch https://github.com/brennoDuarte/ApiDoc.git ApiDoc-v2.0.0-stable

브라우저에서 JavaScript가 활성화되어 있는지 확인하십시오. 다크 모드를 켜면 페이지를 다시로드하자마자 꺼집니다.

구성

JSON 파일은 "JSON"폴더에 있습니다.

다음과 같이 "config.json"파일을 편집 할 수 있습니다.

• "AppName" : 프로젝트 이름,
• "버전" : 프로젝트 버전,
• "설명" : API에 대한 간단한 설명,
• "언어" : API가 만든 언어,
• "프로토콜" : API의 프로토콜, HTTP 또는 HTTPS,

기본 경로를 편집하려면 "router.json"파일을 변경하십시오. URLS 세션은 다음으로 세분화됩니다.

• "PathName" : 엔드 포인트에서 메인 경로 이름을 지정하고
• "ID" : 경로 버튼을 클릭하여 표시되는 모달 ID. 각 엔드 포인트에 대해 다른 ID를 편집해야합니다. 그렇지 않으면 ID가 표시되지 않습니다.
• "pathget/getid/post/put/delete" : API의 종말점,
• "descriptionget/post/put/delete" : 엔드 포인트에 대한 간단한 설명,
• "링크" : 엔드 포인트에서 링크. 클릭하면 새 탭에서 열립니다.

새 경로를 추가하려면 "pathname"에서 "config.json"파일에 복사하여 다른 경로 아래에 붙여 넣습니다.

여러 경로가있는 경우 (Get, Post, Put, Delete) 사용자 정의 경로를 사용하십시오. customRouter.json 파일을 편집 할 수 있습니다.

• "CustomRouter" : 엔드 포인트에서 메인 경로를 지명,
• "유형" : Get, Post, Put, Delete 또는 Other,
• "Path" : API의 종말점,
• "설명" : 엔드 포인트에 대한 간단한 설명,
• "링크" : 엔드 포인트에서 링크. 클릭하면 새 탭에서 열립니다.

API에 특정 요청이없는 경우 필드를 NULL로 변경하십시오. 예:

 " post " : {
    " id " : null,
    " pathPost " : null,
    " descriptionPost " : null,
    " link " : null
},

완료, APIDOC.PHP 파일을 찾아보세요.