ApiGen
v7.0.0-alpha.6
ApiGen هو منشئ مستندات API سهل الاستخدام وحديث يدعم جميع ميزات PHP 8.3 .
يتوفر ApiGen كصورة apigen/apigen Docker والتي يمكنك استخدامها مباشرة.
docker run --rm --interactive --tty --volume " $PWD : $PWD " --workdir " $PWD "
apigen/apigen:edge
src --output docs سيؤدي هذا إلى تثبيت ApiGen phar ثنائي على tools/apigen .
mkdir -p tools
curl -L https://github.com/ApiGen/ApiGen/releases/latest/download/apigen.phar -o tools/apigen
chmod +x tools/apigen
tools/apigen src --output docs سيؤدي هذا إلى تثبيت ApiGen على دليل tools/apigen مع توفر نقطة إدخال قابلة للتنفيذ في tools/apigen/bin/apigen .
composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigen
tools/apigen/bin/apigen src --output docsقم بإنشاء مستندات API عن طريق تمرير أدلة المصدر وخيار الوجهة:
apigen src --output docs يمكن تكوين ApiGen باستخدام ملف التكوين apigen.neon .
parameters :
# string[], passed as arguments in CLI, e.g. ['src']
paths : []
# string[], --include in CLI, included files mask, e.g. ['*.php']
include : [ ' *.php ' ]
# string[], --exclude in CLI, excluded files mask, e.g. ['tests/**']
exclude : []
# bool, should protected members be excluded?
excludeProtected : false
# bool, should private members be excluded?
excludePrivate : true
# string[], list of tags used for excluding class-likes and members
excludeTagged : [ ' internal ' ]
# string, --output in CLI
outputDir : ' %workingDir%/api '
# string | null, --theme in CLI
themeDir : null
# string, --title in CLI
title : ' API Documentation '
# string, --base-url in CLI
baseUrl : ' '
# int, --workers in CLI, number of processes that will be forked for parallel rendering
workerCount : 8
# string, --memory-limit in CLI
memoryLimit : ' 512M '
