ApiDoc

Введение

Apidoc - это шаблон, изготовленный в HTML, PHP и JQUERY, чтобы помочь с документацией PHP REST API.

Установка

Скопируйте ссылку ниже в командную строку, чтобы загрузить последнюю версию. 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". Сессия URL -адреса подразделяется на:

• "PATHNAME" : Назовите основной маршрут из вашей конечной точки,
• «Идентификатор» : модальный идентификатор, который будет отображаться, нажав кнопку «Маршрут». Не забудьте отредактировать свой идентификатор для каждой конечной точки, в противном случае идентификатор не будет отображаться,
• "Pathget/getId/post/put/delete" : конечные точки вашего API,
• "DecriptionGet/post/put/delete" : краткое описание вашей конечной точки,
• «Ссылка» : ссылка из вашей конечной точки. Нажатие на него откроется в новой вкладке.

Чтобы добавить новый путь, скопируйте из «pathname» в файл "config.json" и вставьте его ниже других путей.

Если у вас есть несколько маршрутов (Get, post, plot, delete), используйте пользовательский маршрут. Вы можете отредактировать файл customrouter.json для этого:

• "CustomRouter" : Назовите основной маршрут из вашей конечной точки,
• «Тип» : получить, отправить, положить, удалить или другой,
• «Путь» : конечная точка вашего API,
• «Описание» : краткое описание вашей конечной точки,
• «Ссылка» : ссылка из вашей конечной точки. Нажатие на него откроется в новой вкладке.

Если у вашего API нет определенного запроса, измените поле на NULL. Пример:

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

Сделано, просто откройте файл apidoc.php при любом просмотре.