xiaoymin/knife4j

knife4j 镜像文档

镜像概述和主要用途

knife4j是一款功能强大且轻量级的微服务聚合OpenAPI中间件，可基于Docker镜像在各类场景中便捷使用，旨在简化微服务架构下API文档的聚合与管理，提供统一的接口文档浏览与调试能力。

核心功能和特性

• 轻量级设计：资源占用低，部署简单，适合各类环境
• 微服务聚合：支持聚合多个微服务的OpenAPI文档，实现统一管理
• 多数据源支持：提供本地磁盘（Disk）和Nacos配置中心两种数据源模式
• Docker化部署：支持通过docker-compose快速部署，配置简单

使用场景和适用范围

• 微服务架构下API文档的集中管理与展示
• 需要统一聚合多个OpenAPI文档的场景
• 快速搭建API文档服务，支持接口调试与测试
• 基于Docker环境的便捷部署需求

使用方法和配置说明

部署准备

确保已安装Docker和docker-compose工具。

Disk模式部署

通过本地磁盘存储配置文件，适用于简单场景或单机部署。

docker-compose.yml配置：

yml
# 通过docker-compose快速部署knife4j服务（Disk模式）
version: "2.0"
services:
  knife4j:
    container_name: knife4j-desktop
    restart: always
    image: "xiaoymin/knife4j:v2.0"
    network_mode: "bridge"
    # 本地磁盘目录映射，用于存储配置文件
    volumes:
      - D:\Temp\data:/knife4j/data  # 替换为实际本地目录
    ports:
      - "10000:10000"  # 映射容器端口到主机
    # Disk模式环境变量配置
    environment:
      - knife4j.source=disk  # 指定数据源为本地磁盘
      - knife4j.disk.dir=/knife4j/data  # 容器内配置文件存储路径

启动命令： 在docker-compose.yml所在目录执行：

bash
docker-compose up -d

Nacos模式部署

通过Nacos配置中心获取配置，适用于分布式环境或需要动态配置的场景。

docker-compose.yml配置：

yml
# 通过docker-compose快速部署knife4j服务（Nacos模式）
version: "2.0"
services:
  knife4j:
    container_name: knife4j-desktop
    restart: always
    image: "xiaoymin/knife4j:v2.0"
    network_mode: "bridge"
    volumes:
      - D:\Temp\data:/knife4j/data  # 替换为实际本地目录
    ports:
      - "10000:10000"  # 映射容器端口到主机
    # Nacos模式环境变量配置
    environment:
      - knife4j.source=nacos  # 指定数据源为Nacos
      - knife4j.nacos.server=127.0.0.1:8848  # Nacos服务器地址（替换为实际地址）
      - knife4j.nacos.username=nacos  # Nacos登录用户名
      - knife4j.nacos.password=nacos  # Nacos登录密码
      - knife4j.nacos.namespace=knife4j  # Nacos命名空间（需预先创建）
      - knife4j.nacos.dataId=knife4j_data_id  # Nacos配置DataId（需预先创建）
      - knife4j.nacos.group=DEFAULT_GROUP  # Nacos配置分组

启动命令： 在docker-compose.yml所在目录执行：

bash
docker-compose up -d

环境变量说明

文档地址

详细文档请参考：[***]