@diabelb/api-doc-parser
v0.13.8
Published
Transform an API documentation (Hydra, OpenAPI, GraphQL) in an intermediate representation that can be used for various tasks such as creating smart API clients, scaffolding code or building administration interfaces.
Downloads
3
Readme
API Doc Parser
api-doc-parser
is a standalone TypeScript library to parse Hydra, Swagger, OpenAPI and GraphQL 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';
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';
parseSwaggerDocumentation('https://demo.api-platform.com/docs.json').then(({api}) => console.log(api));
OpenAPI v3
import { parseOpenApi3Documentation } from '@api-platform/api-doc-parser';
parseOpenApi3Documentation('https://demo.api-platform.com/docs.json?spec_version=3').then(({api}) => console.log(api));
GraphQL
import { parseGraphQl } from '@api-platform/api-doc-parser';
parseGraphQl('https://demo.api-platform.com/graphql').then(({api}) => console.log(api));
Support for other formats (JSON:API...)
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.