Ability to cache for offline usage
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- typescript
- 领域
- api
调研方向
首先阅读 src/hydra/parseHydraDocumentation.js，尤其是第 196-442 行链接的 parsing 部分，并查看使用 JSON.stringify() 的现有测试。定义获取与 parsing 之间的边界，然后验证 API 规范可以在不丢失引用的情况下恢复以供离线使用；就设计达成一致也是完成标准的一部分。
由索引模型根据 Issue 内容生成。
描述
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:
I could try to come up with a PR for this but I'd like to get some opinions on that first.
Best
- 主要语言
- TypeScript
- 星标
- 113
- 派生
- 80
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
api-platform/api-doc-parser 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 35/100
api-platform/api-doc-parser#158 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
api-platform/api-doc-parser#130 ·
-
难度 5/5 一周以上 新手友好度 20/100
api-platform/api-doc-parser#129 · 1 条评论 ·
-
api-platform/api-doc-parser#125 · 1 条评论 · 已指派 1 人 ·
-
api-platform/api-doc-parser#115 · 4 条评论 · 已指派 1 人 ·
查看 api-platform/api-doc-parser 的全部 Issue
相似的 Issue
-
blocklist removal
难度 2/5 1-3 小时 新手友好度 65/100
MetaMask/eth-phishing-detect#296544 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
pastelsky/bundlephobia#1122 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
-
category/development priority/P2 scope/file-operations scope/testing type/enhancement
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100