ApiGen

Dokumentasi Cerdas dan Mudah Dibaca untuk proyek PHP

ApiGen mudah digunakan dan generator dokumen API modern yang mendukung semua fitur PHP 8.3 .

Fitur

• phpDokter
  • semua jenis didukung oleh PHPStan
  • deklarasi kelas generik
  • alias tipe lokal
• PHP 8.3
  • konstanta kelas yang diketik
• PHP 8.2
  • konstanta dalam sifat
  • ambil properti enum dalam ekspresi const
  • tipe bentuk normal disjungtif
  • kelas hanya baca
  • tipe benar, salah, dan nol
• PHP 8.1
  • enum
  • tipe persimpangan murni
  • jangan pernah mengetik
  • konstanta kelas akhir
  • baru di inisialisasi
  • properti hanya baca
• PHP 8.0
  • promosi properti konstruktor
  • tipe serikat pekerja
  • tipe campuran
  • tipe pengembalian statis
• PHP 7.4
  • properti yang diketik
• PHP 7.2
  • jenis objek
• PHP 7.1
  • tipe yang dapat dibatalkan
  • tipe yang dapat diubah
  • tipe kosong
  • visibilitas konstan kelas
• PHP 7.0
  • jenis skalar
  • tipe kembalian
• PHP 5.6
  • ekspresi skalar konstan
  • fungsi variadik
• PHP 5.4
  • sifat-sifat
  • tipe yang dapat dipanggil
  • notasi bilangan bulat biner

Dibangun di Pundak Para Raksasa

• nikic/php-parser
• phpstan/phpdoc-parser
• latte/latte
• liga/commonmark

Memasang

Dengan Docker

ApiGen tersedia sebagai image apigen/apigen Docker yang dapat langsung Anda gunakan.

docker run --rm --interactive --tty --volume " $PWD : $PWD " --workdir " $PWD " 
  apigen/apigen:edge 
  src --output docs

Dengan Phar

Ini akan menginstal biner ApiGen phar ke 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

Dengan Komposer

Ini akan menginstal ApiGen ke direktori tools/apigen dengan titik masuk yang dapat dieksekusi tersedia di tools/apigen/bin/apigen .

composer create-project --no-dev apigen/apigen:^7.0@alpha tools/apigen
tools/apigen/bin/apigen src --output docs

Penggunaan

Hasilkan dokumen API dengan meneruskan direktori sumber dan opsi tujuan:

apigen src --output docs

Konfigurasi

ApiGen dapat dikonfigurasi dengan file konfigurasi 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 '