Name: api-doc-parser
Owner: API Platform
Description: Transforms a Hydra API doc in an intermediate representation that can be used for various tasks such as creating smart API clients, scaffolding code or building administration interfaces.
Created: 2017-03-22 10:46:38.0
Updated: 2018-01-19 09:43:23.0
Pushed: 2018-01-18 10:37:13.0
Size: 108
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
api-doc-parser
is a JavaScript (ES6) library to parse Hydra API 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.
With Yarn:
yarn add api-doc-parser
Using NPM:
npm install 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
rt parseHydraDocumentation from 'api-doc-parser/lib/hydra/parseHydraDocumentation';
eHydraDocumentation('https://demo.api-platform.com').then(({api}) => console.log(api));
API Doc Parser is designed to parse any API documentation format and convert it in the same intermediate representation. For now, only Hydra is supported but if you develop a parser for another format, please open a Pull Request to include it in the library.
yarn test
yarn lint
Created by Kévin Dunglas. Sponsored by Les-Tilleuls.coop.