https://github.com/api-platform/api-platform-doc-parsing-check

API-Platform Documentation parsing check
https://github.com/api-platform/api-platform-doc-parsing-check

api debug hydra jsonld

Last synced: 5 months ago
JSON representation

API-Platform Documentation parsing check

• Host: GitHub
• URL: https://github.com/api-platform/api-platform-doc-parsing-check
• Owner: api-platform
• License: mit
• Created: 2017-09-28T18:40:50.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-09-09T17:59:37.000Z (over 2 years ago)
• Last Synced: 2024-11-09T10:11:42.662Z (6 months ago)
• Topics: api, debug, hydra, jsonld
• Language: JavaScript
• Homepage:
• Size: 187 KB
• Stars: 6
• Watchers: 12
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# API Platform Documentation Parsing Check

[![GitHub Actions](https://github.com/api-platform/api-platform-doc-parsing-check/workflows/CI/badge.svg?branch=main)](https://github.com/api-platform/api-platform-doc-parsing-check/actions?query=workflow%3ACI+branch%3Amain)

[![npm version](https://badge.fury.io/js/%40api-platform%2Fapi-platform-doc-parsing-check.svg)](https://badge.fury.io/js/%40api-platform%2Fapi-platform-doc-parsing-check)

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

1. [Create Client](https://api-platform.com/docs/create-client)

2. [Admin](https://api-platform.com/docs/admin)

This tool is using the [API Doc Parser library](https://github.com/api-platform/api-doc-parser) that frontend tools depend on.

## Install

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

## Usage

```console

# 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](screen.png)