qwerty-learner
qwerty-learner copied to clipboard
API 词库使用 DevDocs 数据
很棒的项目!有点打上瘾了,感觉打字练习的正反馈设计得很及时。
最近发现通过打字来熟悉 API 也是个挺不错的方法,特别是通过释义来默写 API。
问题
可是发现了一些问题:
- API 词库不全;
- API 词库的内容过时,如上面的 Array.observe 方法是已经被弃用的方法;
- 释义里包含了 API 对应的单词,达不到默写的要求;
解决方案
为了解决上面的问题,想到了使用 DevDocs 网站的 API 数据,因为它的 API 文档足够全、足够新,数据也经过一些统一的结构化处理。
于是,我在本地尝试了下获取 DevDocs 的 API 数据,按项目词库的格式进行处理,并过滤了释义里的 API 单词,最终解决了我的问题。
建议
根据 DevDocs 的开源协议和版权要求,其它项目想使用它的数据,似乎也不是不可以:
- DevDocs Copyright and License;
- Is it OK to use this project's asset in a related project? · Issue #762 · freeCodeCamp/devdocs · GitHub;
所以有机会的话,可以一起看下这个方案的更多可行性。