https://github.com/konstin/oparl-validator-rs

A tool to find common validity problems in OParl APIs
https://github.com/konstin/oparl-validator-rs

Last synced: 14 days ago
JSON representation

A tool to find common validity problems in OParl APIs

• Host: GitHub
• URL: https://github.com/konstin/oparl-validator-rs
• Owner: konstin
• License: apache-2.0
• Created: 2023-07-03T08:48:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-03T09:41:08.000Z (over 1 year ago)
• Last Synced: 2024-11-26T02:12:45.357Z (about 1 month ago)
• Language: Rust
• Size: 21.3 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: license-apache

Awesome Lists containing this project

README

        
# OParl Validator

This repository contains an [OParl](https://oparl.org/) validator that checks for common validity problems in OParl implementation. It's meant to be used through the CLI, but there's also an experimental web frontend.

## Installation

You can download binaries for windows, mac and linux at https://konstin.github.io/oparl-validator-rs/.

To build from source, [install rust](https://rustup.rs/) and run

```shell

cargo install --git https://github.com/konstin/oparl-validator-rs

```

## Usage

```shell

oparl-validator-rs 

```

This will write a report to `report.txt`. Note that most endpoints are slow so this can easily take more than an hour . There is also a `--cache` option to improve performance and reduce server load with multiple runs. Using `all` as endpoint url validates all of [endpoints.yml](https://github.com/OParl/resources/blob/main/endpoints.yml), writing a report for each endpoint.

## Web frontend

You can build the experimental web frontend with

```shell

npm ci

npm run build

```