Skip to content
This repository has been archived by the owner on Mar 8, 2022. It is now read-only.

uWaterloo/DocumentationGenerator

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Documentation Generator

Given API method schema, the following class will generate a mardown documentation of the method.

This is a proof of concept.

Usage

<?php

require 'src/generator.php';

$api_key   = 'YourAPIKey';
$generator = new DocGenerator($api_key);


$method_schema = 'schema.json'; // local file
#$method_schema = $argv[1]; // first CLI argument

$output = $generator->compile($method_schema);

file_put_contents('method.md', $output);

?>

About

uWaterloo API Documentation Generator (Concept)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%