api-platform / api-platform/api-doc-parser

Ability to cache for offline usage

未关闭
#43 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
Hacktoberfest
主要语言
TypeScript
星标
113
派生
80
PR 合并指标
30 天内没有已合并 PR

描述

Hi,

I'd like to be able to initialize the API specs from an existing cache in order to get the most recently known state of the api docs in case of offline usage.

Basically I need to be able to serialize the specs into JSON and deserialize from JSON. As far as I can see the tests currently utilize `JSON.stringify()` already which is nice but in my case I'm getting issues with an API spec which has circular references internally (e.g. a `Resource` is referencing another `Resource` its `Field.reference` property).

As the `parseHydraDocumentation` is capable of creating those references properly based on the api docs I'm currently thinking that utilizing the collected response(s) for caching and instantiate a new instance of `Api` with its belongings from that state.

If I see it correctly it should be sufficient to separate the "fetch" and "parse" capabilities that are currently handled implicitly in the `parseHydraDocumentation` - like having one separately exported function that does only the parsing which is currently done here:

https://github.com/api-platform/api-doc-parser/blob/a9e097339ecd88b0515238c49e504ff17edcc1c3/src/hydra/parseHydraDocumentation.js#L196-L442

I could try to come up with a PR for this but I'd like to get some opinions on that first.

Best

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。