ApiGen

PHP 프로젝트를 위한 스마트하고 읽기 쉬운 문서

ApiGen은 사용하기 쉽고 모든 PHP 8.3 기능을 지원하는 최신 API 문서 생성기입니다.

특징

• phpDoc
  • PHPStan이 지원하는 모든 유형
  • 일반 클래스 선언
  • 지역 유형 별칭
• PHP 8.3
  • 유형이 지정된 클래스 상수
• PHP 8.2
  • 특성의 상수
  • const 표현식에서 열거형 속성을 가져옵니다.
  • 분리형 정규형 유형
  • 읽기 전용 클래스
  • true, false 및 null 유형
• PHP 8.1
  • 열거형
  • 순수 교차 유형
  • 절대 타자하지 마세요
  • 최종 클래스 상수
  • 이니셜라이저의 새로운 기능
  • 읽기 전용 속성
• PHP 8.0
  • 생성자 속성 프로모션
  • 노동조합 종류
  • 혼합형
  • 정적 반환 유형
• PHP 7.4
  • 입력된 속성
• PHP 7.2
  • 객체 유형
• PHP 7.1
  • 널 입력 가능 유형
  • 반복 가능한 유형
  • 보이드형
  • 클래스의 지속적인 가시성
• PHP 7.0
  • 스칼라 유형
  • 반환 유형
• PHP 5.6
  • 상수 스칼라 표현식
  • 가변 함수
• PHP 5.4
  • 특성
  • 호출 가능 유형
  • 이진 정수 표기법

거인의 어깨 위에 세워진

• nikic/php-파서
• phpstan/phpdoc-파서
• 라떼/라떼
• 리그/커먼마크

설치하다

도커 사용

ApiGen은 직접 사용할 수 있는 apigen/apigen Docker 이미지로 제공됩니다.

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

파와 함께

그러면 tools/apigen 에 ApiGen phar 바이너리가 설치됩니다.

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

작곡가와 함께

그러면 tools/apigen/bin/apigen 에서 사용 가능한 실행 가능 진입점이 있는 tools/apigen 디렉터리에 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 '