check_api
API definition validator (OpenApi/Swagger,RAML,API-Blueprint etc)
Last updated 2 months ago by mermade .
BSD-3-Clause · Repository · Bugs · Original npm · Tarball
$ cnpm install check_api 
SYNC missed versions from official npm registry.

Check_API

check_api is a simple utility wrapping a collection of API definition format validators. It allows you to validate a local file or remote URL with a single command-line or programmatic invocation.

It returns an exitCode of 0 on success and 1 on failure, making it suitable for use in Continuous Integration environments.

Supported Formats

  • Swagger 1.2
  • Swagger / OpenAPI 2.0
  • OpenAPI 3.0.x
  • RAML
  • API Blueprint
  • AsyncAPI 1.0.x

Planned

  • IO Docs
  • WADL
  • Google Discovery Format

API

var check_api = require('check_api');
var options = {};
options.source = 'url_or_filename';
options.convert = false; 
//options.fetchOptions = {...};
check_api.check_api(string_or_object,options,callback);
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 31
Dependencies (11)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |