ApiDoc

Perkenalan

Apidoc adalah templat yang dibuat dalam HTML, PHP dan JQuery untuk membantu dokumentasi API PHP REST.

Instalasi

Salin tautan di bawah ini ke baris perintah Anda untuk mengunduh versi terbaru. Apidoc tidak perlu diinstal pada mesin Anda, cukup klon file dan unzip ke folder server.

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

Pastikan JavaScript diaktifkan di browser Anda. Anda dapat menyalakan mode gelap, tetapi akan mati segera setelah Anda memuat ulang halaman.

Konfigurasikan

File JSON ada di folder "JSON".

Anda dapat mengedit file "config.json" sebagai berikut:

• "AppName" : Nama proyek Anda,
• "Versi" : Versi Proyek Anda,
• "Deskripsi" : Deskripsi singkat API Anda,
• "Bahasa" : Bahasa di mana API Anda dibuat,
• "Protokol" : Protokol API Anda, http atau https,

Untuk mengedit rute default, ubah file "router.json". Sesi URLS dibagi lagi menjadi:

• "Pathname" : Nama rute utama dari titik akhir Anda,
• "ID" : ID modal yang akan ditampilkan dengan mengklik tombol rute. Ingatlah untuk mengedit ID yang berbeda untuk setiap titik akhir, jika tidak ID tidak akan ditampilkan,
• "Pathget/getid/post/put/delete" : titik akhir API Anda,
• "DescriptionGet/Post/Put/Delete" : Deskripsi singkat tentang titik akhir Anda,
• "Tautan" : Tautan dari titik akhir Anda. Mengkliknya akan terbuka di tab baru.

Untuk menambahkan jalur baru, salin dari "pathname" ke dalam file "config.json" dan tempel di bawah jalur lainnya.

Jika Anda memiliki beberapa rute (dapatkan, posting, put, hapus), gunakan rute khusus. Anda dapat mengedit file CustomRouter.json untuk ini:

• "CustomRouter" : Nama rute utama dari titik akhir Anda,
• "ketik" : dapatkan, posting, put, hapus atau lainnya,
• "Path" : Titik akhir API Anda,
• "Deskripsi" : Deskripsi singkat tentang titik akhir Anda,
• "Tautan" : Tautan dari titik akhir Anda. Mengkliknya akan terbuka di tab baru.

Jika API Anda tidak memiliki permintaan tertentu, ubah bidang menjadi NULL. Contoh:

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

Selesai, cukup buka file apidoc.php di penjelajahan apa pun.