Skip to content

Files

Latest commit

brenno-duartebrenno-duarte
Update README.md
Dec 18, 2019
b784560 · Dec 18, 2019

History

History
59 lines (41 loc) · 2.18 KB

README.md

File metadata and controls

59 lines (41 loc) · 2.18 KB

Introduction

ApiDoc is a template made in HTML, PHP and Jquery to assist with PHP REST API documentation.

Installation

Copy the link below to your command line to download the latest version. ApiDoc does not need to be installed on your machine, just clone the file and unzip it to the server folder.

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

Make sure JavaScript is enabled in your browser. You can turn on dark mode, but it will turn off as soon as you reload the page.

Configure

The json files are in the "json" folder.

You can edit the file "config.json" as follows:

  • "appName": your project name,
  • "version": your project version,
  • "description": a brief description of your api,
  • "language": the language in which your API was made,
  • "protocol": your api's protocol, HTTP or HTTPS,

To edit default routes, change the "router.json" file. The urls session is subdivided into:

  • "pathName": name main route from your endpoint,
  • "id": modal id that will be displayed by clicking the route button. Remember to edit a different id for each endpoint, otherwise the id will not be displayed,
  • "pathGet/GetId/Post/Put/Delete": endpoints of your API,
  • "descriptionGet/Post/Put/Delete": a brief description of your endpoint,
  • "link": link from your endpoint. Clicking it will open in a new tab.

To add a new path, copy from "pathName" into the "config.json" file and paste it below the other paths.

If you have multiple routes (get, post, put, delete), use a custom route. you can edit the customrouter.json file for this:

  • "customRouter": name main route from your endpoint,
  • "type": GET, POST, PUT, DELETE or other,
  • "path": endpoint of your API,
  • "description": a brief description of your endpoint,
  • "link": link from your endpoint. Clicking it will open in a new tab.

If your api does not have a certain request, change the field to null. Example:

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

Done, just open the apidoc.php file in any browse.