README.md

API Platform Documentation Parsing Check

Simple CLI app to check your API Platform's API documentation prior to run the frontend tools:

1. Create Client
2. Admin

This tool is using the API Doc Parser library that frontend tools depend on.

Install

npm install @api-platform/api-platform-doc-parsing-check

Usage

# Hydra
node_modules/@api-platform/api-platform-doc-parsing-check/lib/index.js http://localhost:8080/

# OpenAPI 3
node_modules/@api-platform/api-platform-doc-parsing-check/lib/index.js -f openapi3 http://localhost:8080/docs.json

Check Result: