ApiDocダウンロード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」を編集できます。

デフォルトルートを編集するには、「router.json」ファイルを変更します。 URLSセッションは次のように細分化されます。

「PathName」 ：エンドポイントからメインルートに名前を付け、
「ID」 ：[ルート]ボタンをクリックして表示されるモーダルID。エンドポイントごとに別のIDを編集することを忘れないでください。そうしないと、IDが表示されません。
「pathget/getId/post/put/delete」 ：APIのエンドポイント、
「DescriptionSet/Post/Put/Delete」 ：エンドポイントの簡単な説明、
「リンク」 ：エンドポイントからのリンク。クリックすると、新しいタブが開きます。

新しいパスを追加するには、「pathname」から「config.json」ファイルにコピーし、他のパスの下に貼り付けます。

複数のルートがある場合（取得、投稿、配置、削除）、カスタムルートを使用します。これについては、customrouter.jsonファイルを編集できます。

APIに特定のリクエストがない場合は、フィールドをNULLに変更します。例：

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

完了して、閲覧でapidoc.phpファイルを開くだけです。

拡大する

追加情報