ApiDoc

Introduction

APIDOC est un modèle fabriqué en HTML, PHP et JQuery pour aider à la documentation de l'API PHP REST.

Installation

Copiez le lien ci-dessous sur votre ligne de commande pour télécharger la dernière version. APIDOC n'a pas besoin d'être installé sur votre machine, il suffit de cloner le fichier et de le décompresser dans le dossier du serveur.

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

Assurez-vous que JavaScript est activé dans votre navigateur. Vous pouvez activer le mode sombre, mais il s'éteindra dès que vous rechargez la page.

Configurer

Les fichiers JSON sont dans le dossier "JSON".

Vous pouvez modifier le fichier "config.json" comme suit:

• "Appname" : le nom de votre projet,
• "Version" : votre version de projet,
• "Description" : une brève description de votre API,
• "Langue" : la langue dans laquelle votre API a été faite,
• "Protocole" : le protocole de votre API, HTTP ou HTTPS,

Pour modifier les routes par défaut, modifiez le fichier "router.json". La session URLS est subdivisée en:

• "PathName" : nom de la route principale depuis votre point de terminaison,
• "ID" : ID modal qui sera affiché en cliquant sur le bouton d'itinéraire. N'oubliez pas de modifier un ID différent pour chaque point de terminaison, sinon l'ID ne sera pas affiché,
• "pathget / getId / post / put / delete" : points de terminaison de votre API,
• "DescriptionGet / Post / Put / Delete" : une brève description de votre point de terminaison,
• "Lien" : lien à partir de votre point de terminaison. Cliquez sur celui-ci s'ouvrira dans un nouvel onglet.

Pour ajouter un nouveau chemin, copiez de "PathName" dans le fichier "config.json" et collez-le sous les autres chemins.

Si vous avez plusieurs itinéraires (obtenez, publiez, put, supprimez), utilisez un itinéraire personnalisé. Vous pouvez modifier le fichier CustomRouter.json pour ceci:

• "CustomRouter" : Nommez la route principale depuis votre point de terminaison,
• "Type" : obtenir, publier, mettre, supprimer ou autre,
• "chemin" : point final de votre API,
• "Description" : une brève description de votre point de terminaison,
• "Lien" : lien à partir de votre point de terminaison. Cliquez sur celui-ci s'ouvrira dans un nouvel onglet.

Si votre API n'a pas une certaine demande, modifiez le champ en null. Exemple:

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

Terminé, ouvrez simplement le fichier APIDOC.php dans n'importe quel parcours.