skilltechgroup/gtrans-dominio-api

镜像概述和主要用途

本Docker镜像为轻量级域名相关API服务解决方案，旨在提供便捷的域名功能集成能力。通过容器化部署，可快速搭建支持域名查询、管理等操作的API服务，减少服务搭建复杂度，适用于需要集成域名功能的各类应用系统。

核心功能和特性

核心功能

• 域名WHOIS信息查询：支持查询域名注册商、注册时间、过期时间等WHOIS详细信息
• DNS记录管理：提供DNS记录（A、CNAME、MX等类型）的添加、删除、查询功能
• 域名可用性检查：实时检测指定域名是否可注册
• 域名状态监控：监控域名注册状态、解析状态等关键信息

主要特性

• 轻量级部署：基于精简基础镜像，镜像体积小，资源占用低
• RESTful API设计：遵循REST规范，接口易用性强，便于开发集成
• 可配置性：支持通过环境变量自定义服务端口、超时时间等参数
• 跨平台兼容：兼容主流Docker环境，支持Linux、Windows、macOS等操作系统

使用场景和适用范围

适用场景

• 域名管理系统开发：作为后端API服务支撑域名管理平台功能实现
• DNS服务集成：为应用系统提供DNS记录动态管理能力
• 域名注册平台：支持域名可用性检查、WHOIS信息展示等核心功能
• 开发者测试环境：快速搭建域名相关API服务用于功能调试和原型验证

适用人群/团队

• 域名服务提供商技术团队
• 企业IT部门（需管理内部域名资源）
• 独立开发者（开发域名相关应用）
• 中小型网站运维团队（需监控域名状态）

详细使用方法和配置说明

基本部署（docker run命令）

通过以下命令快速启动服务：

bash
docker run -d -p 8080:8080 --name domain-api-service [镜像名称]:latest

• -p 8080:8080：将容器内8080端口映射到主机8080端口（默认服务端口）
• --name domain-api-service：指定容器名称，便于管理

环境变量配置

支持通过环境变量自定义服务参数，常用配置如下：

带环境变量的启动示例：

bash
docker run -d -p 9000:9000 \
  -e PORT=9000 \
  -e API_KEY=abc123 \
  -e LOG_LEVEL=debug \
  --name domain-api-service [镜像名称]:latest

docker-compose配置示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  domain-api:
    image: [镜像名称]:latest
    container_name: domain-api-service
    ports:
      - "8080:8080"
    environment:
      - PORT=8080
      - API_KEY=your_api_key_here
      - TIMEOUT=30
    restart: unless-stopped

通过docker-compose up -d启动服务。

API使用示例

服务启动后，可通过HTTP请求调用API，以下为常用接口示例：

1. 域名WHOIS查询

bash
curl "http://localhost:8080/api/whois?domain=example.com" -H "X-API-Key: your_api_key_here"

返回示例（JSON格式）：

json
{
  "domain": "example.com",
  "registrar": "Example Registrar",
  "creationDate": "2020-01-01",
  "expirationDate": "2030-01-01",
  "status": "active"
}

2. 域名可用性检查

bash
curl "http://localhost:8080/api/check?domain=example-new.com" -H "X-API-Key: your_api_key_here"

返回示例：

json
{
  "domain": "example-new.com",
  "available": true,
  "reason": "No registration records found"
}