Doxygen API 문서 검색, 이제 더 강력하게!

by DD
2년 전
조회수 5

Doxygen API 문서 검색 시 기본 검색 기능의 한계를 지적하고 외부 검색 기능 설정을 소개함

아파치 HTTP 서버NGINX를 활용한 외부 검색 기능 설정 방법 상세 설명

CGI 바이너리 파일 실행을 위한 FcgiWrap리버스 프록시 설정 방법 제시

Doxygen 외부 검색 원리

Doxygen은 API 문서 자동 생성 도구로, CGI 바이너리 파일을 통해 외부 검색 기능을 제공한다. 구체적으로 Xapian 검색 엔진을 활용하여 단어 기반 검색의 한계를 극복한다. 따라서 SEARCHENGINE, EXTERNAL_SEARCH 옵션 설정을 통해 외부 검색을 활성화한다.

아파치 vs NGINX: CGI 설정 비교

아파치 HTTP 서버는 CGI 설정을 직접 지원하지만, NGINX는 FastCGI를 권장한다. FcgiWrap을 사용하면 NGINX에서 CGI 바이너리 파일을 쉽게 실행할 수 있다. 반면, 리버스 프록시 설정을 통해 아파치 CGI를 NGINX로 연결하는 방법도 존재하며, 유연한 설정이 가능하다.

실전 적용 가이드: WAS별 설정

NGINX 환경에서는 FcgiWrap 설치 후 설정 파일을 복사하고, NGINX 설정을 수정한다. 구체적으로 fcgiwrap.conf 파일을 include하고, fastcgi_param 설정을 조정한다. 따라서 CGI 실행 경로를 정확히 설정해야 하며, 아파치 리버스 프록시 설정 시 포트 충돌에 유의해야 한다.

30분만 투자하면 사용하는 API 문서 검색 엔진, Doxygen 외부 검색 설정하기