目录

一、公共脚本

1、概念

2、公共脚本的使用背景

3、优缺点

二、使用方式

1、管理公共脚本

2、引用公共脚本

三、普通脚本调用公共脚本

1、使用场景

2、注意事项

3、对比示例

四、公共脚本总结

1、总结：

2、使用注意点：

---

一、公共脚本

1、概念

Apifox的公共脚本是指可以在多个API中共享和复用的JavaScript脚本。它们可以在Apifox的全局脚本库中定义，并在不同的API中引用和调用。

公共脚本的概念有以下几个关键点：

1. 共享和复用：公共脚本可以在多个API中进行共享和复用。这意味着你只需要定义一次脚本，然后可以在多个API中引用它，而不需要重复编写相同的代码。

2. 全局脚本库：Apifox提供了一个全局脚本库，用于存储和管理公共脚本。你可以在脚本库中创建和编辑脚本，并为其指定一个唯一的名称。

3. 引用和调用：在API的前置脚本或后置脚本中，你可以通过名称引用和调用公共脚本。这样可以将公共脚本的逻辑应用到特定的API中，实现代码的复用和统一管理。

2、公共脚本的使用背景

1）实现脚本复用，避免多处重复编写相同功能的脚本

2）相同功能的脚本或通用类、方法可放到公共脚本中供接口直接引用

3、优缺点

使用Apifox的公共脚本功能有以下优点和缺点：

优点：
1.代码复用性：公共脚本可以在多个API中共享和复用，避免了重复编写相同的代码，提高了开发效率。
2. 管理效率：公共脚本可以在全局脚本库中定义和管理，方便统一管理和更新，减少了维护工作量。
3. 可扩展性：公共脚本可以根据需要进行扩展和修改，满足不同API的需求，提供了更大的灵活性。

缺点：

1. 学习成本：使用公共脚本功能需要一定的JavaScript编程知识，对于不熟悉JavaScript的用户来说，可能需要一定的学习成本。
2. 脚本正确性和稳定性：公共脚本的正确性和稳定性对整个API的运行效果有重要影响，需要确保脚本的质量和稳定性，避免出现错误和异常情况。
3. 安全性：公共脚本可能包含敏感信息或逻辑，需要注意安全性问题，确保脚本的安全性，避免信息泄露和恶意使用。

总体而言，使用Apifox的公共脚本功能可以提高代码的复用性和管理效率，但需要注意脚本的正确性、稳定性、可维护性和安全性。

二、使用方式

1、管理公共脚本

打开 项目设置->公共脚本，在这里管理公共脚本

2、引用公共脚本

接口运行界面或接口用例界面的前置脚本和后置脚本，可直接引用公共脚本。

注意：

• 公共脚本是在普通脚本之前执行的。
• 多个公共脚本执行顺序和添加的顺序保持一致。

三、普通脚本调用公共脚本

1、使用场景

1.1、普通脚本需要调用公共脚本里的变量或者方法。

1.2、公共脚本之间相互调用。

1.3、后置脚本和调用前置脚本。

2、注意事项

2.1、为了避免脚本间的变量冲突，所有脚本执行都需要在各自的作用域（通过闭包包裹）下运行的，使用var、let、const、function声明的变量或者方法都是局部变量或者局部方法，所以不能被其他脚本调用，如果想要变量或者方法被其他脚本调用，需要改成全局变量或全局方法。

2.2、请务必注意确保不同脚本之间全局变量或者全局方法命名没有冲突。

2.3、接口用例，需要在前置脚本或后置脚本里添加了公共脚本才能能调用公共脚本

2.4、调用脚本需要注意脚本执行顺序，只有后置的脚本可以调用先执行的脚本。

3、对比示例

3.1 、局部变量与全局变量的声明

// 声明局部变量，无法被其他脚本调用

var my_var = "hello"；

要改成：

// 声明全局变量，可以被其他脚本调用

my_var = 'hello';

3.2、局部方法与全局方法的声明

// 声明局部方法，无法被其他脚本调用

function my_fun(name) {

  console.log('hello' + name);

}

要改成：

// 声明全局方法，可以被其他脚本调用

my_fun = function(name) {

  console.log('hello' + name);

};

改成全局变量或者全局方法后即可被其他脚本之间调用。

四、公共脚本总结

1、总结：

• Apifox的公共脚本是一种可以在多个API中共享和复用的JavaScript脚本。
• 公共脚本可以在全局脚本库中定义和管理，提高代码的复用性和管理效率。
• 使用公共脚本可以实现自动化处理任务、数据处理和转换、环境变量设置等功能。

2、使用注意点：

1. JavaScript编程知识：使用公共脚本需要一定的JavaScript编程知识，确保脚本的正确性和稳定性。
2. 脚本的可维护性：编写公共脚本时，注意代码的可读性和可维护性，使其易于理解和修改。
3. 脚本的安全性：确保脚本中不包含敏感信息，避免泄露和滥用。
4. 脚本的复用性：设计公共脚本时，考虑其在不同API中的复用性，尽量使其通用而不是过于特定。
5. 全局脚本库的管理：合理组织和管理全局脚本库，方便脚本的查找、更新和版本控制。

通过遵循这些注意点，您可以更好地使用Apifox的公共脚本功能，提高工作效率和代码管理效果。