devatherock/ldap-search-api

ldap-search-api

ldap-search-api 是一个用于查询LDAP服务器的简单REST API，提供便捷的HTTP接口来执行LDAP查询操作，支持通过环境变量或配置文件自定义LDAP连接、认证、连接池等参数，并集成Swagger API文档便于接口调试。

核心功能与特性

• 提供RESTful接口查询LDAP服务器，支持自定义查询过滤器和结果数量限制
• 支持多种LDAP认证方式（none、simple），适配不同LDAP服务器配置
• 可配置LDAP连接池，优化连接复用，提升查询性能
• 灵活的日志配置，支持调整日志级别、输出JSON格式日志
• 集成Swagger API文档，可通过/swagger-ui访问接口详情

使用场景与适用范围

• Web应用需要通过HTTP接口查询LDAP用户或组织数据
• 自动化脚本或工具中需便捷访问LDAP服务器信息
• 需要简化LDAP查询流程，避免直接处理LDAP协议复杂性的场景

使用方法与配置说明

示例启动命令

docker run --rm \
  -p 8080:8080 \
  -e LDAP_HOST=ldaps://ldap.jumpcloud.com:636 \
  -e LDAP_USERNAME=devatherock \
  -e LDAP_PASSWORD=dummy \
  devatherock/ldap-search-api:latest

可配置属性

API 规范

应用运行时，可通过 {host}/swagger-ui 或 {host}/swagger/ldap-search-api-{version}.yml 访问详细的API文档。以下为可用端点参考：

• /search?filter=<ldap查询语句>&limit=<结果数量> - 在指定的基准DN下使用提供的过滤条件搜索LDAP

示例响应

json
[
    {
        "loginShell": "/bin/bash",
        "uid": "testdummy",
        "homeDirectory": "/home/test",
        "mail": "test.dummy@dummy.com",
        "uidNumber": "1234",
        "givenName": "Test",
        "objectClass": [
            "top",
            "person",
            "organizationalPerson",
            "inetOrgPerson",
            "shadowAccount",
            "posixAccount",
            "jumpcloudUser"
        ],
        "sn": "User",
        "gidNumber": "1234",
        "cn": "Test User"
    }
]

故障排除

启用调试日志

• 设置环境变量 LOGGER_LEVELS_ROOT 为 DEBUG 以启用所有调试日志（自定义和框架）
• 设置环境变量 LOGGER_LEVELS_IO_GITHUB_DEVATHEROCK 为 DEBUG 仅启用自定义代码的调试日志
• 如需精细控制日志，可提供自定义 logback.xml 文件，并设置环境变量 LOGBACK_CONFIGURATION_FILE 为 /path/to/custom/logback.xml

JSON 日志

参考 https://github.com/logstash/logstash-logback-encoder 文档自定义日志中的字段名称和格式。如需以JSON格式输出日志，设置环境变量 LOGBACK_CONFIGURATION_FILE 为 logback-json.xml