Skip to content

Latest commit

 

History

43 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

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

1 star

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages