NEI-TS

TypeScript 的好处不言而喻，简单地说，它可以让大家在编写代码时获得更好的编程体验（智能补全）以及未来重构项目时不至于瑟瑟发抖。

Mug-SSR 的一个功能点是默认支持 TypeScript。

借助 TypeScript 的类型推导，大部分情况下，我们只需要编写简单的数据类型就可以完成日常的开发中，但是在涉及到接口请求时，接口的出入参的定义，则需要我们手动地从 NEI 上抄写下来，另外还需要手动的保持和 NEI 的同步。

即使没有使用 TS 的项目，仍然可以使用此插件进行接口信息的拉取，这样在编写接口调用代码的时候，就会有方便的编辑器提示了

安装

我们可以直接在 VSCode 中搜索 nei 来找到并安装插件：

token

插件需要访问 NEI 的 OpenAPI 以拉取接口和数据类型的信息，为此需要先配置 NEI 的访问令牌，访问令牌可以在 这里 生成，页面的参数可以参考下面的截图：

然后在插件配置项 Access Token 中填入生成好的 Token：

@music/nei-types

生成的代码需要引用到一些通用的类型，这些类型用于规范接口的出入参格式。因为是通用的类型，所以它们被放到独立的包中，即 @music/nei-types

可以使用下面的命令在项目中加入对它的依赖：

$ npm i @music/nei-types

这些类型都只是 TypeScript 定义，目的就是方便静态类型检查，并不会增加项目的体积

如何使用

开发

目前包含的内容为：

• codegen 为 NEI 上的接口生成对应的 TypeScript 调用方法
• types NEI 生成后的代码使用的类型定义
• vscode-nei 在 VSCode 中方便进行 NEI 代码生成及使用

codegen 和 types 包含了接口代码生成的核心功能，独立出它们来方便其他的编辑器工具进行集成；在这些功能之上制作的 vscode-nei 负责在 VSCode 中提供便捷的交互

反馈

欢迎在 这里 反馈任何意见和建议