const axios = require('axios');
const url = 'https://myapi.com';
/**
* This object is used to interact with your APIs.
* In this example, we'll assume you require a single API key.
*
* @param {string} apiKey API key.
*/
const MyPackage = function MyPackage(apiKey) {
this.apiKey = apiKey;
}
2条答案
按热度按时间k7fdbhmy1#
我可以自己把东西弄出来,因此成功注册了npm包@https://npmjs.org/package/javascript-boilerplate
请按照我所问的顺序找到答案。
1.对于特定的文件夹结构没有强制要求
1.在这里我得到了这个问题,它本质上是从jquery 1.8.3 npm包驱动的,只是删除了它,并将jQuery仅与我的捆绑包一起发布
1.我不需要文件夹
1.我不认为有,可能是全局npm安装需要
tkclm6bt2#
以下是如何为NodeJS创建NPM包。在这个例子中,NPM包的目的是为现有的API创建一个接口。
设置项目。
开始,你需要初始化一个NodeJS进程。
为项目创建一个新文件夹,用Visual Studio Code(或您喜欢的编辑器)打开它,然后在命令行中键入npm init。按照屏幕上的过程添加您的软件包的名称和任何其他详细信息,您希望包括。完成后,将创建一个package.js文件,您可以运行npm install axios来安装Axios依赖项,我们将使用该依赖项向您的API发出请求。
创建index.js文件。
现在您的项目已经设置好了,我们可以开始编写与您的API交互的代码了。
创建一个名为index.js的文件,在顶部我们将声明axios依赖项,后面是API的基本URL。然后我们将创建与您的API接口的对象。
字符串
添加您的端点。
为了与您的API进行交互,我们将为您的API上的每个端点创建函数。这些函数将接受所有相关数据、查询和参数,并发出相应的Axios请求,将数据返回给用户。请参见以下示例:
型
您可以为所有端点复制此布局,并添加您喜欢的任何其他逻辑。可能会建议捕获axios请求中的任何错误,但为了简单起见,上面省略了这一点。函数上方的注解将显示给软件包的用户,以解释每个函数的用途,因此请确保包含所有必要的详细信息。
结束您的包裹。
添加完所有API必需的端点后,只需将以下代码添加到index.js文件中即可导出对象:
型
完成了!现在你有了一个可以发布到NPM的包。
我强烈推荐在线工具apitopackage.zip,它使用AI为您生成NPM包(比这里显示的结构更好),而不是手动创建包。
希望这对你有帮助!