apigility-raml-validator

, _(*1)

This is a tool to help validate your Apigility implementation against a RAML specification. This way you can make sure the implementation matches the specification requirements., _(*2)

In comparison with similar tools this application does not check the output of the api but the code structure directly., _(*3)

Please note that this tool is in early stages of development., _(*4)

Installation
Usage
Validation

Installation

composer require --dev "robertboloc/apigility-raml-validator"
chmod +x vendor/bin/apigility-raml-validator

Usage

vendor/bin/apigility-raml-validator [--help] [-s spec, --spec spec] [-p project, --project project]

Options

spec (-s | --spec)

Path to the RAML specification file, _(*5)

target (-p | --project)

Path to the Apigility project containing the source code, _(*6)

module (-m | --module)

Hint the name of the module in case it's different from the API name, _(*7)

help (--help)

Display the usage message, _(*8)

debug (--debug)

Enable debug messages when running the application, _(*9)

Validation

This is the list of fields from the RAML specification currently being validated, _(*10)

RAML	Apigility
title	Check a module matching `title` exists
version	Check a version folder matching `version` exists
resource *	Check a route has been defined for the `resource`
method	Check a collection route implements the methods of a top resource

* only top level resources are detected for now, _(*11)

Example

Highlighted in green are the lines of the RAML specification currently being validated against the implementation, _(*12)

  #%RAML 1.0
+ title: Test
+ version: v1
- protocols: HTTPS
- mediaType: application/json
- baseUri: https://api.test.com/{version}
- description: My Test API

+ /foo:
+   get:
+     description: My test endpoint

+ /bar:
+   post:
+     description: Another test endpoint