fnash/hydra-doc-parser

Hydra API documentation parser

0.1 2018-11-09 11:14 UTC

Requires

• skyscanner/jsonpath: ^1.0

MIT

• Fayez Naccache

README

Parse Hydra documentation to extract Resources and readable Fields. Detects if a given field is a scalar, or a link (jsonld IRI) to one or many Resources.

Install

$ composer require fnash/hydra-doc-parser dev-master

Use

require_once 'vendor/autoload.php';

$doc = \Fnash\HydraDoc\HydraDoc::fromUrl('https://demo.api-platform.com/docs.jsonld');

echo $doc->pretty();

- #ConstraintViolation
--- message: xmls:string
--- propertyPath: xmls:string
- #ConstraintViolationList
--- violations: #ConstraintViolation
- #Entrypoint
- #Parchment
--- description: xmls:string
--- title: xmls:string
- http://schema.org/Book
--- author: xmls:string
--- description: xmls:string
--- isbn: xmls:string
--- publicationDate: xmls:dateTime
--- reviews: http://schema.org/Review
--- title: xmls:string
- http://schema.org/Review
--- author: xmls:string
--- body: xmls:string
--- book: http://schema.org/Book
--- letter: xmls:string
--- publicationDate: xmls:dateTime
--- rating: xmls:integer