ohmyform/api

OhMyForm API 镜像文档

镜像概述和主要用途

OhMyForm API 是 OhMyForm 项目的后端服务，作为 TypeForm 的开源替代方案，提供创建移动就绪的表单、调查和问卷的功能。所有 API 调用通过 GraphQL 接口进行，端点在 GET /graphql 提供可内省的模式，便于开发者集成和使用。

核心功能和特性

• 开源替代方案：作为 TypeForm 的开源替代品，提供类似的表单创建和管理功能
• GraphQL 接口：所有 API 交互通过 GraphQL 实现，支持灵活的数据查询和操作
• 可内省的 API 模式：通过 GET /graphql 端点提供可内省的 schema，便于开发者了解和使用 API
• 移动就绪：支持创建适配移动设备的表单、调查和问卷

使用场景和适用范围

• 个人或组织需要自建表单系统、调查工具，替代商业表单服务
• 开发者需要集成表单功能到自有应用中，通过 GraphQL API 进行数据交互
• 教育机构、企业用于收集用户反馈、进行问卷调查等场景

使用方法和配置说明

基本使用

该镜像为 OhMyForm 的 API 后端服务，通常需要配合前端服务使用。基础运行命令示例：

bash
docker run -d -p 3000:3000 --name ohmyform-api ohmyform/api

开发环境运行

若需在开发模式下运行（watch 模式），可使用以下命令：

bash
docker run -d -p 3000:3000 -v $(pwd):/app --name ohmyform-api-dev ohmyform/api yarn run start:dev

生产环境运行

生产模式运行命令：

bash
docker run -d -p 3000:3000 --name ohmyform-api-prod ohmyform/api yarn run start:prod

GraphQL 接口访问

API 的 GraphQL 端点可通过 http://localhost:3000/graphql 访问，支持通过 GET 请求获取可内省的 schema，通过 POST 请求进行数据操作。