@korbiniankuhn/obj2doc

Parse json or javascript objects to an API documentation format.

Stats

StarsIssuesVersionUpdatedCreatedSize
@korbiniankuhn/obj2doc
081.0.22 years ago4 years agoMinified + gzip package size for @korbiniankuhn/obj2doc in KB

Readme

obj2doc

Travis Coverage Known Vulnerabilities Dependencies Dev Dependencies npm npm-version license

Convert js/json objects to API documentation formats. Supported formats:

  • RAML

Installation

For installation use the Node Package Manager:

$ npm install --save @korbiniankuhn/obj2doc

or clone the repository:

$ git clone https://github.com/KorbinianKuhn/obj2doc

Getting started

const obj2doc = require('@korbiniankuhn/obj2doc');

obj2doc(object, { type: 'raml' });
// return raml string

Testing

First you have to install all dependencies:

$ npm install

To execute all unit tests once, use:

$ npm test

To get information about the test coverage, use:

$ npm run coverage

Contribution

Get involved and push in your ideas.

Do not forget to add corresponding tests to keep up 100% test coverage.

License

The MIT License

Copyright (c) 2018 Korbinian Kuhn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.