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

可配置属性

环境变量名称	YAML变量名称	是否必填	默认值	描述
LDAP_HOST	ldap.host	是	(无)	LDAP服务器的完整主机名。示例：`ldaps://ldap.jumpcloud.com:636`
LDAP_USERNAME	ldap.username	否	(无)	LDAP绑定用户名。根据LDAP服务器配置，可为简单用户名（如`devatherock`）或DN（如`uid=devatherock,ou=Users,dc=jumpcloud,dc=com`）
LDAP_PASSWORD	ldap.password	否	(无)	LDAP绑定密码
LDAP_AUTH_TYPE	ldap.auth-type	否	simple	`java.naming.security.authentication`属性值。支持的值为`none`、`simple`，默认为`simple`
LDAP_BASE_DN	ldap.base-dn	否	(无)	默认的搜索基准DN
LDAP_BINARY_ATTRIBUTES	ldap.binary-attributes	否	(无)	搜索结果中包含二进制值的属性
LDAP_READ_TIMEOUT_MILLIS	ldap.read-timeout-millis	否	***	搜索的读取超时时间（毫秒），默认为10秒
LDAP_CONNECTION_POOL_ENABLED	ldap.connection-pool.enabled	否	true	是否启用连接池
LDAP_CONNECTION_POOL_CORE_SIZE	ldap.connection-pool.core-size	否	8	连接池初始大小
LDAP_CONNECTION_POOL_MAX_SIZE	ldap.connection-pool.max-size	否	8	连接池最大大小
LDAP_CONNECTION_POOL_TIME_TO_LIVE_MILLIS	ldap.connection-pool.timeToLiveMillis	否	***	连接池中连接的存活时间（毫秒），默认为30分钟
LOGGER_LEVELS_ROOT	(无)	否	INFO	SLF4J日志级别，适用于所有（框架和自定义）代码
LOGGER_LEVELS_IO_GITHUB_DEVATHEROCK	(无)	否	INFO	SLF4J日志级别，仅适用于自定义代码
MICRONAUT_SERVER_PORT	micronaut.server.port	否	8080	应用监听的端口
MICRONAUT_CONFIG_FILES	(无)	否	(无)	YAML配置文件路径，可用于指定复杂、对象或数组类型的属性
JACKSON_SERIALIZATION_INDENT_OUTPUT	jackson.serialization.indent-output	否	(无)	设置为`true`可启用响应的JSON格式化输出（美化打印）
LOGBACK_CONFIGURATION_FILE	(无)	否	(无)	logback配置文件路径

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": "***",
        "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