终极指南：如何为RomM生成Python/JavaScript API客户端

RomM是一款功能强大的自托管ROM管理器，提供美观的界面和丰富的功能来管理您的游戏ROM集合。通过其OpenAPI接口，开发者可以轻松构建自定义客户端来扩展RomM的功能。本文将详细介绍如何为RomM生成Python和JavaScript API客户端，帮助您快速集成RomM的强大功能到自己的项目中。[![RomM游戏库界面](https://raw.gitcode.com/GitHub_T

解佳岭Farley

413人浏览 · 2026-02-18 06:30:08

解佳岭Farley · 2026-02-18 06:30:08 发布

终极指南：如何为RomM生成Python/JavaScript API客户端

【免费下载链接】romm A beautiful, powerful, self-hosted rom manager 项目地址: https://gitcode.com/GitHub_Trending/rom/romm

RomM的游戏库界面展示了其美观的设计和丰富的功能

为什么需要RomM API客户端？

RomM作为一款自托管的ROM管理器，提供了完整的RESTful API接口，允许开发者：

自动化ROM管理流程
构建自定义前端界面
集成到家庭自动化系统
开发移动应用或远程控制工具
创建游戏推荐或统计分析工具

通过自动生成的API客户端，开发者可以避免手动编写API调用代码，节省时间并减少错误。

准备工作

在开始生成API客户端之前，确保您已完成以下准备工作：

安装RomM并确保其正常运行
安装Node.js和npm（用于JavaScript客户端生成）
安装Python和pip（用于Python客户端生成）
克隆RomM仓库：

git clone https://gitcode.com/GitHub_Trending/rom/romm
cd romm

RomM API基础

RomM使用FastAPI构建其后端服务，自动生成OpenAPI规范。您可以通过访问以下URL获取完整的API文档：

Swagger UI: http://localhost:5000/docs
OpenAPI JSON: http://localhost:5000/openapi.json

RomM的API结构在./backend/main.py中定义，包含多个路由模块，如：

认证（auth）
用户管理（user）
平台管理（platform）
ROM管理（rom）
搜索功能（search）

RomM的游戏详情页面展示了API可以获取的丰富元数据

生成JavaScript客户端

RomM前端项目已经配置了API客户端生成工具。以下是生成步骤：

确保RomM后端服务正在运行
进入前端目录：

cd frontend

安装依赖：

npm install

运行生成命令：

npm run generate

这个命令会执行package.json中定义的generate脚本：

"generate": "openapi --input http://127.0.0.1:5000/openapi.json --output ./src/__generated__ --client axios --useOptions --useUnionTypes --exportServices false --exportSchemas false --exportCore false"

生成的TypeScript类型定义将保存在./frontend/src/__generated__/目录下，包含所有API模型，如：

CollectionSchema
PlatformSchema
RomSchema
DetailedRomSchema

生成Python客户端

虽然RomM官方没有提供Python客户端生成脚本，但您可以使用openapi-python-client工具手动生成：

安装openapi-python-client：

pip install openapi-python-client

生成客户端：

openapi-python-client generate --url http://localhost:5000/openapi.json --output-dir romm-api-client

安装生成的客户端：

cd romm-api-client
pip install .

使用生成的客户端

JavaScript/TypeScript示例

import { RomSchema, PlatformSchema } from './src/__generated__';
import axios from 'axios';

// 获取所有平台
async function getPlatforms() {
  try {
    const response = await axios.get('/api/platforms');
    const platforms: PlatformSchema[] = response.data;
    console.log('Platforms:', platforms);
    return platforms;
  } catch (error) {
    console.error('Error fetching platforms:', error);
  }
}

// 获取特定ROM详情
async function getRomDetails(romId: string) {
  try {
    const response = await axios.get(`/api/roms/${romId}`);
    const rom: RomSchema = response.data;
    console.log('ROM Details:', rom);
    return rom;
  } catch (error) {
    console.error('Error fetching ROM details:', error);
  }
}

Python示例

from romm_api_client import Client
from romm_api_client.models import RomSchema, PlatformSchema

client = Client(base_url="http://localhost:5000")

# 获取所有平台
def get_platforms():
    try:
        response = client.platform.get_platforms()
        platforms: list[PlatformSchema] = response.data
        print("Platforms:", platforms)
        return platforms
    except Exception as e:
        print("Error fetching platforms:", e)

# 获取特定ROM详情
def get_rom_details(rom_id: str):
    try:
        response = client.rom.get_rom(rom_id=rom_id)
        rom: RomSchema = response.data
        print("ROM Details:", rom)
        return rom
    except Exception as e:
        print("Error fetching ROM details:", e)

自定义和扩展客户端

生成的客户端提供了基础的API调用功能，您可以根据需要进行扩展：

添加认证处理
实现缓存机制
添加错误处理和重试逻辑
封装常用操作组合

例如，创建一个RomManager类来封装常用功能：

class RomManager {
  private apiBaseUrl: string;
  
  constructor(apiBaseUrl: string = '/api') {
    this.apiBaseUrl = apiBaseUrl;
  }
  
  async searchRom(query: string): Promise<RomSchema[]> {
    const response = await axios.get(`${this.apiBaseUrl}/search`, { 
      params: { q: query } 
    });
    return response.data;
  }
  
  async addToFavorites(romId: string): Promise<RomSchema> {
    const response = await axios.post(`${this.apiBaseUrl}/roms/${romId}/favorite`);
    return response.data;
  }
  
  // 更多自定义方法...
}