GBFS-Validator

GBFS Validator is a command-line tool for validating General Bikeshare Feed Specification (GBFS) data feed and outputing the report in a JSON file

Add the Dependency

To use gbfs-validator in your own project, you need to first install our Node.js npm package:

npm install gbfs-validator

Supported GBFS Versions

• 3.1-RC
• 3.0
• 2.3
• 2.2
• 2.1
• 2.0
• 1.1
• 1.0

Example Code

const GBFS = require('gbfs-validator');

const feedUrl = "https://gbfs.velobixi.com/gbfs/gbfs.json";
const feedOptions = {}
const gbfs = new GBFS(feedUrl, feedOptions)

gbfs.validation().then((reportResults) => {
    // reportResults: GBFS Validation Report Results in JSON 
}).catch(error => {
    // error handling 
})

gbfs.getFiles().then((gbfsFeedFiles) => {
    // gbfsFeedFiles: Info about GBFS feed 
}).catch(error => {
    // error handling 
})

Usage of the Command Line Interface

How to validate a feed and place the report in a located file

gbfs-validator -u {http_address_of_gbfs_dataset} -s {local_path_to_output_report_file}

Example of the CLI

gbfs-validator -u https://gbfs.velobixi.com/gbfs/gbfs.json -s ~/Documents/log.json

Options

-v,  --version: output the version number
-u,  --url <feed_url>: URL of the GBFS feed
-vb, --verbose: Verbose mode prints debugging console logs
-s,  --save-report <report_path>: Local path to output report file
-pr, --print-report <yes_no>: Print report to standard output (choices: "yes", "no", default: "yes")
-h,  --help: display help for command