Forge Node.js SDK 使用指南

Forge Node.js SDK 使用指南

forge-api-nodejs-clientForge Node.js SDK: Provides Node.js SDK to help you easily integrate Forge REST APIs into the application项目地址:https://gitcode.com/gh_mirrors/fo/forge-api-nodejs-client

项目介绍

Forge Node.js SDK 是一个由Autodesk维护的Node.js客户端库，旨在简化开发者将Forge REST API集成到其应用中的过程。它支持OAuth 2.0认证，并涵盖了包括数据管理、模型衍生命令在内的多个Forge服务。特别指出，该SDK已经不再支持Design Automation v2，鼓励开发者迁移到v3版本。为了使用这个库，你需要有一个注册在Forge Developer门户的应用程序，以及至少Node.js v10.12或更高版本的环境。

项目快速启动

安装Forge API SDK

首先，确保你的开发环境中已安装Node.js。然后，在你的项目目录中，通过npm安装Forge APIs：

npm install forge-apis --save

配置Forge应用程序

• 登录Forge Developer Portal，创建一个新的应用程序。
• 记录下客户端ID（Client ID）和客户端密钥（Client Secret）。

基本认证示例

接下来，我们将展示如何进行基本的OAuth认证并获取访问令牌，这是使用Forge API的先决条件。

const ForgeAPI = require('forge-apis');
const fs = require('fs');

// 配置你的客户端凭据
const credentials = {
    clientId: 'YOUR_CLIENT_ID',
    clientSecret: 'YOUR_CLIENT_SECRET'
};

const oauth2TwoLegged = new ForgeAPI.AuthClientTwoLegged(credentials.clientId, credentials.clientSecret, ['data:read', 'data:create']);

async function getAccessToken() {
    try {
        const token = await oauth2TwoLegged.authenticate();
        console.log(`Access Token: ${token.access_token}`);
        // 接下来你可以使用这个access_token来调用Forge的REST API
    } catch (error) {
        console.error('Error getting access token:', error);
    }
}

getAccessToken();

应用案例和最佳实践

应用Forge Node.js SDK的最佳实践通常包括处理异步操作、错误管理和适时刷新访问令牌。例如，当你处理大型文件上传或频繁的数据查询时，应采用Promise或async/await模式以保持代码清晰和响应式。

示例：列出项目

以下是一个简单的例子，展示了如何使用SDK列出用户的Forge项目：

const { DataManagementApi } = require('forge-apis');
// 使用之前获取的access_token初始化API实例
const dataManagementApi = new DataManagementApi({
    accessToken: 'YOUR_ACCESS_TOKEN',
});

async function listProjects() {
    try {
        const projects = await dataManagementApi.getProjects();
        projects.data.forEach(project => console.log(project.attributes.name));
    } catch (error) {
        console.error("Failed to list projects:", error);
    }
}

listProjects();

典型生态项目

Forge生态系统广泛应用于建筑、制造、媒体和娱乐等行业，支持从设计协作到生产自动化的一系列工作流程。例如，结合Forge的Data Management API和Model Derivative API，开发者可以构建云原生的BIM查看器，允许团队远程审查建筑设计；或者利用Design Automation API自动化参数化设计生成，提高制造业的设计效率。

通过这些工具和最佳实践的实施，开发者能够在各自领域内创建高效、交互性强的应用程序，充分挖掘Forge平台的强大功能。

---

以上就是基于Forge Node.js SDK的基础使用指南，希望它能够帮助你迅速上手并探索Forge API的无限可能。在实际开发过程中，详细查阅Forge的官方文档和社区资源将会是宝贵的辅助。

forge-api-nodejs-clientForge Node.js SDK: Provides Node.js SDK to help you easily integrate Forge REST APIs into the application项目地址:https://gitcode.com/gh_mirrors/fo/forge-api-nodejs-client