ApiDoc

Einführung

APIDOC ist eine Vorlage, die in HTML, PHP und JQuery erstellt wurde, um die PHP -REST -API -Dokumentation zu unterstützen.

Installation

Kopieren Sie den Link unten in Ihre Befehlszeile, um die neueste Version herunterzuladen. APIDOC muss nicht auf Ihrem Computer installiert werden, klonen Sie einfach die Datei und entpacken Sie sie in den Serverordner.

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

Stellen Sie sicher, dass JavaScript in Ihrem Browser aktiviert ist. Sie können den Dunklen Modus einschalten, aber er wird ausgeschaltet, sobald Sie die Seite neu laden.

Konfigurieren

Die JSON -Dateien befinden sich im Ordner "JSON".

Sie können die Datei "config.json" wie folgt bearbeiten:

• "AppName" : Ihr Projektname,
• "Version" : Ihre Projektversion,
• "Beschreibung" : Eine kurze Beschreibung Ihrer API,
• "Sprache" : Die Sprache, in der Ihre API gemacht wurde,
• "Protokoll" : Das Protokoll Ihrer API, http oder https,

Ändern Sie die Datei "Router.json", um Standardrouten zu bearbeiten. Die URLS -Sitzung ist unterteilt in:

• "Pathname" : Nennen Sie die Hauptroute von Ihrem Endpunkt,
• "ID" : Modale ID, die durch Klicken auf die Schaltfläche Routen angezeigt wird. Denken Sie daran, eine andere ID für jeden Endpunkt zu bearbeiten, andernfalls wird die ID nicht angezeigt.
• "Pathget/getId/post/put/löschen" : Endpunkte Ihrer API,
• "Beschreibung/Post/Put/Löschen" : Eine kurze Beschreibung Ihres Endpunkts,
• "Link" : Link aus Ihrem Endpunkt. Wenn Sie darauf klicken, wird in einer neuen Registerkarte geöffnet.

Um einen neuen Pfad hinzuzufügen, kopieren Sie von "PathName" in die Datei "config.json" und fügen Sie ihn unter die anderen Pfade ein.

Wenn Sie mehrere Routen haben (erhalten, posten, setzen, löschen), verwenden Sie eine benutzerdefinierte Route. Sie können die Datei "CustomRouter.json" bearbeiten:

• "CustomRouter" : Nennen Sie die Hauptroute von Ihrem Endpunkt,
• "Typ" : Holen Sie sich, posten, setzen, löschen oder andere,
• "Pfad" : Endpunkt Ihrer API,
• "Beschreibung" : Eine kurze Beschreibung Ihres Endpunkts,
• "Link" : Link aus Ihrem Endpunkt. Wenn Sie darauf klicken, wird in einer neuen Registerkarte geöffnet.

Wenn Ihre API keine bestimmte Anfrage hat, ändern Sie das Feld in Null. Beispiel:

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

Öffnen Sie einfach die Datei apidoc.php in einem beliebigen Durchsuchen.