Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Paw Generator for ApiDoc

Build Status Coverage Status Code Climate Issue Count License

generates the inline documenation for the RESTful APIs.

Installation

Clone this git repo into your extensions folder as com.ygilany.PawExtensions.apiDocGenerator.

Change Log

v 1.2.0

I appologize to all users of this extenstions for not mainitaint it. I didn't realize anyone was using it until very soon. Also all PRs are welcome

  • uses get-data-type npm module instead of parsing the datatype myself.
  • update the handlebars template to include the curly brackets surrounding the data types and the method
  • generate the docs for the response only when the response status code is 200. (instead of previously depending on a property called status having the value SUCCESS)
  • generate apiName based on concatenation of the requestName
  • present the first letter of the datatypes in upper case format
  • replaced vars with consts

v 1.1.0 (in development)

  • parsing the API Version, permissions and name from the description if the description was parsable, otherwise, keep as is.

v 1.0.0

  • The core functionality of the extension.

About

No description or website provided.

Topics

Resources

License

Packages

No packages published
You can’t perform that action at this time.