Apidog Docs
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  • 🇪🇸 Español
  • 🇰🇷 한국인
  • 🇨🇳 简体中文
  • 🇵🇹 Português (Portugal)
  • 🇮🇩 Bahasa Indonesia
  • 🇧🇷 Português (Brasil)
  • 🇻🇳 Tiếng Việt
  • 🇨🇳 繁體中文
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
  1. 动态值模块
  • Apidog 学习中心
  • 入门
    • Apidog 简介
    • Apidog 中的基本概念
    • 导航 Apidog
    • 快速开始
      • 概述
      • 创建端点
      • 发送请求
      • 添加断言
      • 创建测试场景
      • 共享 API 文档
      • 探索更多
    • 迁移到 Apidog
      • 概述
      • 手动导入
      • 定时导入(绑定数据源)
      • 导入选项
      • 导出数据
      • 导入自
        • 从 Postman 导入
        • 导入 OpenAPI 规范
        • 导入 cURL
        • 导入 Markdown
        • 从 Insomnia 导入
        • 从 apiDoc 导入
        • 导入 .har 文件
        • 导入 WSDL
  • Mock API 数据
    • 概述
    • Smart Mock
    • 自定义模拟
    • 模拟优先级顺序
    • 模拟脚本
    • 云端模拟
    • 自托管 Runner 模拟
    • 模拟语言(区域设置)
  • 账号与偏好设置
    • 账户设置
    • 生成 OpenAPI 访问令牌
    • 通知
    • 语言设置
    • 快捷键
    • 网络代理配置
    • 备份数据
    • 更新 Apidog
    • 删除账户
    • 实验性功能
  • 发送请求
    • 概述
    • SSE 调试
    • MCP 客户端
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP 或 WebService
    • GraphQL
    • gRPC
    • 使用请求代理 Agent 进行调试
    • 创建请求
      • 请求历史
      • 请求基础
      • 参数和主体
      • 请求头部
      • 请求设置
      • 调试请求
      • 将请求保存为端点
      • HTTP/2
    • 身份验证与授权
      • 概述
      • CA 和客户端证书
      • 授权类型
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk 身份验证
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • 响应和 Cookie
      • 查看 API 响应
      • 管理 Cookie
      • 概述
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 调试用例
    • 测试用例
    • 动态值
    • 验证响应
    • Design-First vs Request-First
    • 生成代码
    • 环境与变量
      • 概览
      • 使用变量
      • 环境管理
    • Vault 密钥
      • 概述
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • 动态值模块
      • Airline
      • 动物
      • 颜色
      • 商务
      • Company
      • 数据库
      • 数据类型
      • 日期
      • Finance
      • 食物
      • Git
      • Hacker
      • Helpers
      • 图像
      • Internet
      • 位置
      • Lorem
      • 音乐
      • 数字
      • Person
      • 电话
      • 科学
      • String
      • System
      • Vehicle
      • Word
    • 前置和后置处理器
      • 概述
      • 断言
      • 提取变量
      • 等待
      • 安全
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle 客户端
      • 使用脚本
        • 概述
        • 预处理器脚本
        • 后处理器脚本
        • 公共脚本
        • Postman 脚本参考
        • 调用其他编程语言
        • 使用 JS 库
        • 可视化响应
        • 脚本示例
          • 断言脚本
          • 使用变量
          • 修改请求
          • 其他示例
    • API 调试
      • AI Agent Debugger
      • A2A 调试器
  • 设计 API
    • 概述
    • 创建新的 API 项目
    • 端点基础
    • API 设计指南
    • 模块
    • 配置多个请求主体示例
    • 组件
    • 通用字段
    • 全局参数
    • 端点变更历史
    • 评论
    • 批量端点管理
    • 自定义协议 API
    • Spec-first 模式(Beta)
    • 安全方案
      • 概述
      • 创建安全方案
      • 使用安全方案
      • 在线文档中的安全方案
    • 高级功能
      • 自定义端点字段
      • 关联的测试场景
      • 端点状态
      • 参数列表的外观
      • 端点唯一标识
    • Schemas
      • 概述
      • 创建新 Schema
      • 构建 Schema
      • 从 JSON 等生成 Schema
      • oneOf, allOf, anyOf
      • 使用 Discriminator
  • Apidog Europe
    • Apidog Europe
  • API 测试
    • 概述
    • 测试场景
      • 创建测试场景
      • 在请求之间传递数据
      • 流程控制条件
      • 从端点和端点用例同步数据
      • 从其他项目导入端点和端点用例
      • 导出测试场景
    • 测试报告
      • 测试报告
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 共享测试数据
      • 定时任务
      • 管理来自其他项目的 API 运行环境
    • 测试套件
      • 概述
      • 创建测试套件
      • 编排测试套件
      • 本地运行测试套件
      • 通过 CLI 运行测试套件
      • 定时任务
    • 测试 API
      • 集成测试
      • 性能测试
      • 端到端测试
      • 回归测试
      • 契约测试
    • Apidog CLI
      • 概述
      • 安装和运行 Apidog CLI
      • Apidog CLI 选项
    • CI/CD
      • 概述
      • 与 Github Actions 集成
      • 与 Gitlab 集成
      • 与 Jenkins 集成
      • 通过 Git Commit 触发测试
  • 发布 API 文档
    • 概述
    • 支持的 API 技术
    • 快速分享
    • 查看 API 文档
    • Markdown 文档
    • 发布文档站点
    • 自定义登录页面
    • 自定义布局
    • 自定义 CSS、JavaScript、HTML
    • 自定义域名
    • AI 功能
    • SEO 设置
    • 高级设置
      • 文档搜索
      • CORS 代理
      • 集成 Google Analytics
      • 文件夹树设置
      • 可见性设置
      • 在文档 URL 中嵌入值
    • API 版本
      • 概述
      • 创建 API 版本
      • 发布 API 版本
      • 共享带有 API 版本的端点
  • 分支
    • 概述
    • 创建 Sprint 分支
    • 在分支中测试 API
    • 在分支中设计 API
    • 合并 Sprint 分支
    • 管理 Sprint 分支
    • AI Branch(Beta)
  • AI 功能
    • 概述
    • 启用 AI 功能
    • 生成测试用例
    • 使用 AI 修改 Schema
    • 端点合规性检查
    • API 文档完整性检查
    • AI 驱动的字段命名
    • 常见问题
  • Apidog MCP 服务器
    • 概述
    • 将 Apidog 项目连接到 AI
    • 将已发布的文档连接到 AI
    • 将 OpenAPI 文件连接到 AI
  • 最佳实践
    • 处理 API 签名
    • 访问受 OAuth 2.0 保护的 API
    • 协作工作流
    • 管理身份验证状态
  • 离线空间
    • 概述
  • 管理
    • 管理项目
      • 管理项目
      • 通知设置
      • 管理项目成员
      • 项目资源
        • 数据库连接
        • Git 连接
    • 管理团队
      • 管理团队
      • 管理团队成员
      • 团队活动
      • 团队角色与权限
      • 团队资源
        • General Runner
        • 团队变量
        • 请求代理 Agent
      • 实时协作
        • 团队协作
    • 入门检查清单
      • 基本概念
      • 入门指南
    • 管理组织
      • 管理组织
      • 组织角色与权限
      • 套餐管理
        • 组织中的账单管理员
      • 单点登录 (SSO)
        • SSO 概述
        • 配置 Microsoft Entra ID
        • 配置 Okta
        • 为组织配置 SSO
        • 管理用户账户
        • 将组映射到团队
      • SCIM 配置
        • SCIM 预配简介
        • Microsoft Entra ID
        • Okta
      • 组织资源
        • 自托管 Runner
  • 计费
    • 概述
    • 积分
    • 升级您的套餐
    • 替代支付方式
    • 管理订阅
    • 将付费团队移入组织
  • 附加组件
    • API Hub
    • Apidog Intellij IDEA 插件
    • 浏览器扩展
      • Chrome
      • Microsoft Edge
    • 请求代理
      • Web 中的请求代理
      • 共享文档中的请求代理
      • 客户端中的请求代理
  • 数据与安全
    • 数据存储和安全
    • 用户数据隐私与安全
    • 请求路由与数据安全
  • 参考
    • API 设计优先方法
    • Apidog OpenAPI 规范扩展
    • JSONPath
    • XPath
    • 正则表达式
    • JSON Schema
    • CSV 文件格式
    • 安装 Java 环境
    • Runner 部署环境
    • Apidog Markdown 语法
    • Apidog Swagger 扩展
      • 概述
      • x-apidog-folder
      • x-apidog-status
      • x-apidog-name
      • x-apidog-maintainer
    • Apidog JSON Schema 扩展
      • 概述
      • x-apidog-mock
      • x-apidog-orders
      • x-apidog-enum
  • 支持中心
  1. 动态值模块

位置

用于生成地址和位置的模块。

模块概览#

对于某个区域设置的典型街道地址,请使用 {{$location.streetAddress}}、{{$location.city}}、{{$location.state}} 和 {{$location.zipCode}}。大多数区域设置会为特定国家提供本地化版本。
如果你需要纬度和经度坐标,请使用 {{$location.latitude}} 和 {{$location.longitude}},或使用 {{$location.nearbyGPSCoordinateLatitude}} 获取给定位置附近的纬度/经度。
对于随机国家/地区,你可以使用 {{$location.country}} 或 {{$location.countryCode}}。

buildingNumber#

生成随机建筑编号。
返回:string
示例

cardinalDirection#

返回随机基本方位。
参数
名称类型默认值描述
abbreviatedbooleanfalse如果为 true,则返回缩写方位(N、E 等)。否则返回完整名称。
返回:string
示例

city#

生成随机本地化城市名称。
返回:string
示例

country#

返回随机国家/地区名称。
返回:string
示例

countryCode#

返回随机国家/地区代码。
参数
名称类型默认值描述
variant'alpha-2' |'alpha-3' | 'numeric''alpha-2'要返回的代码。可以是 'alpha-2'(两个字母代码)、'alpha-3'(三个字母代码)或 'numeric'(数字代码)。
返回:string
示例

direction#

返回随机方向。
参数
名称类型默认值描述
abbreviatedbooleanfalse如果为 true,则返回缩写方向(NW、E 等)。否则返回完整名称。
返回:string
示例

latitude#

生成随机纬度。
参数
名称类型默认值描述
maxnumber90要生成的纬度上限。
minnumber-90要生成的纬度下限。
precisionnumber4纬度的小数精度位数。
返回:number
示例

longitude#

生成随机经度。
参数
名称类型默认值描述
maxnumber90要生成的经度上限。
minnumber-90要生成的经度下限。
precisionnumber4经度的小数精度位数。
返回:number
示例

nearbyGPSCoordinate#

在距给定坐标的指定半径范围内生成随机 GPS 坐标。
INFO
原始的 faker.location.nearbyGPSCoordinate() 方法已细化为两个更精确的变量:
{{$location.nearbyGPSCoordinateLatitude}}:在距给定坐标的指定半径范围内生成一个纬度。
{{$location.nearbyGPSCoordinateLongitude}}:在距给定坐标的指定半径范围内生成一个经度。
参数
名称类型默认值描述
isMetricbooleanfalse如果为 true,则假定半径单位为公里。如果为 false,则单位为英里。
latitudenumber用于获取附近新坐标的原始纬度。
longitudenumber用于获取附近新坐标的原始经度。
radiusnumber10从给定坐标到新坐标的最大距离。
返回: [latitude: number, longitude: number]
示例

ordinalDirection#

返回随机序数方位(northwest、southeast 等)。
参数
名称类型默认值描述
abbreviatedbooleanfalse如果为 true,则返回缩写方向(NW、SE 等)。否则返回完整名称。
返回:string
示例

secondaryAddress#

生成随机本地化二级地址。这指的是给定地址中的特定位置,例如公寓或房间号。
返回:string
示例

state#

返回随机本地化州/省,或该区域设置国家/地区的其他等效一级行政实体,例如省或地区。通常,这些是某个国家/地区的 ISO 3166-2 细分。如果某个区域设置不对应一个特定国家/地区,该方法可能会返回使用该语言的一个或多个国家/地区的 ISO 3166-2 细分。例如,ar 区域设置包含来自阿拉伯语国家/地区的细分,如突尼斯、阿尔及利亚、叙利亚、黎巴嫩等。出于历史兼容性原因,默认的 en 区域设置仅包含美国的州(与 en_US 相同)。不过,如果需要,你可以使用其他英语区域设置,例如 en_IN、en_GB 和 en_AU。
参数
名称类型默认值描述
abbreviatedbooleanfalse如果为 true,则返回缩写的一级行政实体名称。否则返回完整名称。
返回:string
示例

street#

生成随机本地化街道名称。
返回:string
示例

streetAddress#

生成随机本地化街道地址。
参数
名称类型默认值描述
useFullAddressboolean为 true 时,将生成完整地址。否则仅生成街道地址。
返回:string
示例

timeZone#

返回与此区域设置相关的随机 IANA 时区。
返回的时区与当前区域设置相关联。
返回:string
示例

zipCode#

根据指定格式生成随机邮政编码。如果未指定格式,则使用该区域设置的邮政编码格式。
参数
名称类型默认值描述
formatstring用于生成邮政编码的可选格式。如果指定了 state 选项,则不会使用此格式。
返回:string
示例
Modified at 2026-06-09 08:55:47
Previous
Internet
Next
Lorem
Built with