apidoc-request

apidoc template for request

Usage no npm install needed!

<script type="module">
  import apidocRequest from 'https://cdn.skypack.dev/apidoc-request';
</script>

README

apidoc-request

apidoc-request is a tool for replacing the apidoc default template. It depends on apidoc.

Usage

$ npm install apidoc -g
$ npm install apidoc-request -g
$ apidoc -i app/controllers/ -o public/doc/
$ cd public/doc/
$ apidoc-request

The template generated by apidoc-request depends on the api_data.json generated by apidoc. So you must first execute the apidoc to generate the template directory.

Page screenshot

Screenshot