Nexus API 的入门教程与使用指南

一、前言：为什么选择 Nexus API？

在当今 DevOps 与网络自动化双重驱动的时代，Nexus API 已成为制品管理和网络设备编程的核心利器。无论是通过 Sonatype Nexus Repository REST API 实现制品仓库自动化，还是利用 Cisco Nexus NX‑API 完成网络设备编程与监控，Nexus API 都能帮助团队：

• 快速集成 CI/CD 流程，实现制品从构建、测试到发布的全链路自动化
• 在大规模数据中心环境中，通过脚本或工具远程管理交换机、路由器配置
• 降低人为失误，提升跨团队协作效率

本篇教程从基础概念、实践示例、工具集成，到优化与最佳实践，全面覆盖 Nexus API 入门 和进阶使用，让你零门槛掌握 API 自动化运维与仓库管理技巧。

二、Sonatype Nexus Repository REST API 深度入门

1. Nexus Repository 简介

Sonatype Nexus Repository（以下简称 Nexus）是一款功能强大的制品库管理工具，支持 Maven、npm、Docker、PyPI 等多种格式。通过 Nexus REST API，你可以在 CI/CD 管道中无缝地完成仓库创建、权限配置、构件上传与清理等关键操作，大幅提升 DevOps 自动化效率。

2. Nexus API 架构与端点

Nexus 3.x 版本主要提供以下 REST 接口：

• OpenAPI/Swagger 文档：访问 http:// < nexus-host > /service/rest/swagger.json，即可获得完整 JSON 定义，并可在 Swagger UI 中交互测试。
• 身份验证：支持 HTTP Basic（用户名/密码）和 Token 方式，将凭证安全地存储在 Vault、GitHub Secrets、Jenkins 凭证等集中管理平台中。

3. 实战：四步在 CI/CD 中创建 Maven 仓库

以下示例展示如何在 Jenkins Pipeline 中通过 REST API 自动创建一个 Maven Hosted 仓库，并赋予特定角色权限。

3.1 准备 Groovy 脚本 createMavenRepo.groovy

import org.sonatype.nexus.repository.storage.WritePolicy
repository.createMavenHosted(
  'internal-maven',            // 仓库名称
  'maven2',                    // 格式
  'default',                   // Blob store
  true,                        // 发布策略
  WritePolicy.ALLOW,           // 写入策略
  false,                       // 暂存策略
  null                         // 恢复策略
)

3.2 上传并执行脚本

# 1. 上传脚本
curl -u admin:admin123
  -X POST http://nexus.example.com/service/rest/v1/script
  -H "Content-Type: application/json"
  -d '{
    "name": "createMavenRepo",
    "type": "groovy",
    "content": "'"$(sed ':a;N;$!ba;s/n/n/g' createMavenRepo.groovy)"'"
  }'

# 2. 执行脚本
curl -u admin:admin123
  -X POST http://nexus.example.com/service/rest/v1/script/createMavenRepo/run

提示：在 Jenkins Pipeline 中，可使用 sh 步骤依次执行上述命令，并在参数化构建时传入仓库名称、Blob store 等。

4. 构件上传与清理

• 上传构件：使用标准 Maven Deploy Plugin 或直接调用 REST API POST /service/rest/v1/components?repository= < repo > 上传多种格式制品。

• 自动清理：通过 REST API 调用 /service/rest/v1/tasks，创建清理任务（Cleanup policy），定期删除快照、过期制品，避免存储爆满。

• ---

三、Cisco Nexus 交换机 NX‑API 快速上手

1. 什么是 NX‑API？

NX‑API 是 Cisco Nexus 网络设备提供的 API 接口，允许开发者用 HTTP/HTTPS 调用 CLI 命令，实现与交换机的编程式交互。支持 JSON 和 XML 格式，结合 JSON‑RPC 可模拟 CLI 行为。

2. 启用与安全配置

conf t
  feature nxapi
  nxapi http port 80
  nxapi https port 443
  ip http secure-server
end

• HTTPS 建议：生产环境务必开启 ip http secure-server，并绑定合法证书。
• 身份验证：可配合 AAA、本地用户或 TACACS+、RADIUS 实现集中认证。

3. 请求示例

3.1 JSON‑RPC 调用

POST https://nexus-switch/api/ins
Content-Type: application/json
{
  "ins_api": {
    "version": "1.0",
    "type": "cli_show",
    "chunk": "0",
    "sid": "1",
    "input": "show version",
    "output_format": "json"
  }
}

返回示例包含设备型号、IOS 版本等信息，通过 JSON 路径快速解析。

3.2 RESTConf 对象模型

部分新机型支持 RESTConf（基于 YANG 数据模型），可用 [curl](https://www.explinks.com/wiki/what-are-curl-url-uri/) -X GET https:// < switch > /restconf/data/interfaces 获取接口列表信息。

四、工具与脚本集成

五、最佳实践与安全建议

1. 凭证管理：将 admin 凭证和 API Token 存放在 Vault、Jenkins 凭证中，避免硬编码。
2. 最小权限原则：为 CI/CD 服务账号创建专属角色，仅包含所需仓库和操作权限。
3. 审计日志：定期导出 Nexus 审计日志与 NX‑API 调用记录，以便追溯与合规。
4. 性能监控：利用 Nexus 内部 /service/rest/v1/status 和 NX‑API Sandbox 监测接口健康状况。
5. 版本兼容：关注 Nexus 与 Nexus Pro、NX OS 版本差异，升级前务必在测试环境验证 API 行为。

六、实践案例：CI/CD 与网络统一自动化

一个真实案例显示，某大型电商团队将 Nexus API 与 NX‑API 集成至同一 Jenkins Pipeline：

1. 构件发布：构建完成后，调用 Nexus API 创建临时 Maven 仓库并上传快照。
2. 网络配置：并行触发 Python 脚本，通过 NX‑API 动态修改流量镜像、ACL 规则。
3. 回滚机制：若任一步骤失败，Pipeline 调用 Nexus API 删除临时仓库，并通过 NX‑API 恢复交换机配置。
4. 监控与告警：所有 API 调用结果推送到 ELK Stack，关联 Grafana 仪表盘监控指标。

该流程实现制品管理与网络变更统一编排，推送速度提升 40%，故障恢复时间缩短 60%。

七、总结与下一步

本文系统梳理了 Nexus API 在制品管理与网络自动化中的双重价值，涵盖：

• Sonatype Nexus Repository REST API：仓库创建、脚本执行、构件上传、清理策略
• Cisco NX‑API：CLI 级别 JSON 调用、RESTConf 对象模型、脚本集成
• 实战示例：Jenkins Pipeline、Python 脚本自动化
• 安全与最佳实践：凭证管理、最小权限、审计与监控

下一步建议：

• 在测试环境中反复演练脚本并编写单元/集成测试
• 将关键 API 调用纳入 SRE 监控，设置告警阈值
• 探索 Nexus Pro 高级功能（Staging API、Repository Health Check）
• 深入 YANG/RESTConf 数据模型，实现更加智能的网络状态管理

掌握 Nexus API，你将拥有贯通制品仓库与网络设备的自动化金钥，开启 DevOps + NetOps 新篇章！

原文引自YouTube视频：https://www.youtube.com/watch?v=_tn1dDmxiBw