🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@api-platform/api-doc-parser

Package Overview
Dependencies
Maintainers
6
Versions
47
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@api-platform/api-doc-parser

Transform a Hydra API documentation in an intermediate representation that can be used for various tasks such as creating smart API clients, scaffolding code or building admininistration interfaces.

0.9.1
Source
npm
Version published
Weekly downloads
4.3K
-33.96%
Maintainers
6
Weekly downloads
 
Created
Source

API Doc Parser

Build Status npm version

api-doc-parser is a standalone TypeScript library to parse Hydra, Swagger and OpenAPI documentations and transform them in an intermediate representation. This data structure can then be used for various tasks such as creating smart API clients, scaffolding code or building administration interfaces.

It plays well with the API Platform framework.

Install

With Yarn:

yarn add @api-platform/api-doc-parser

Using NPM:

npm install @api-platform/api-doc-parser

If you plan to use the library with Node, you also need a polyfill for the fetch function:

yarn add isomorphic-fetch

Usage

Hydra

import parseHydraDocumentation from '@api-platform/api-doc-parser/lib/hydra/parseHydraDocumentation';

parseHydraDocumentation('https://demo.api-platform.com').then(({api}) => console.log(api));

OpenAPI v2 (formerly known as Swagger)

import parseSwaggerDocumentation from '@api-platform/api-doc-parser/lib/swagger/parseSwaggerDocumentation';

parseSwaggerDocumentation('https://demo.api-platform.com/docs.json').then(({api}) => console.log(api));

OpenAPI v3

import parseOpenApi3Documentation from '@api-platform/api-doc-parser/lib/openapi3/parseOpenApi3Documentation';

parseOpenApi3Documentation('https://demo.api-platform.com/docs.json?spec_version=3').then(({api}) => console.log(api));

Support for other formats (GraphQL, JSONAPI...)

API Doc Parser is designed to parse any API documentation format and convert it in the same intermediate representation. If you develop a parser for another format, please open a Pull Request to include it in the library.

Run tests

yarn test
yarn lint

Credits

Created by Kévin Dunglas. Sponsored by Les-Tilleuls.coop.

FAQs

Package last updated on 15 May 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts