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

0.2.0 • Public • Published

API Platform Documentation Parsing Check

GitHub Actions npm version

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:

Result

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

    Package Sidebar

    Install

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

    Weekly Downloads

    35

    Version

    0.2.0

    License

    MIT

    Unpacked Size

    10.4 kB

    Total Files

    13

    Last publish

    Collaborators

    • dunglas
    • simperfit
    • mysiar
    • meyerbaptiste
    • teohhanhui
    • soyuka