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.
MIT License
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.
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
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));
In order to support OpenAPI, the library makes some assumptions about how the documentation relates to a corresponding ressource:
GET
) or edit (PUT
) one resource looks like /books/{id}
(regular expression used: ^[^{}]+/{[^{}]+}/?$
).books
may be a singular noun (book
).get
either in the [response
/ 200
/ content
/ application/json
] path section or in the components
section of the documentation.components
section, the component name needs to look like Book
(singular noun).put
, the schema is only retrieved in the [requestBody
/ content
/ application/json
] path section.get
and one for put
), resource fields are merged.POST
) and list (GET
) path. They need to look like /books
(plural noun).DELETE
) path needs to be inside the get / edit path.reviews
property, the library tries to find a Review
resource.Book
and Review
resources is made for the reviews
field.review_id
, reviewId
, review_ids
or reviewIds
for references.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.
yarn test
yarn lint
Created by Kévin Dunglas. Sponsored by Les-Tilleuls.coop.