APIFuzzer

(★ 467)

Fuzz test your application using your OpenAPI or Swagger API definition without coding

  • .editorconfig
  • .gitignore
  • .pylintrc
  • .scrutinizer.yml
  • .travis.yml
  • APIFuzzer
  • docker-compose.yml
  • Dockerfile
  • entrypoint.sh
  • json_ref_resolve.py
  • LICENSE
  • pyproject.toml
  • README.md
  • requirements.txt
  • run_test
  • setup.py

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/KissPeter/APIFuzzer

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd APIFuzzer

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. 공식 설치 스크립트

쉬움 추천
사전 준비물
  • Python 3 pip 명령어를 쓰려면 Python이 필요합니다.
pip3 install APIFuzzer

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

설치 후 새 터미널을 열고, 프로그램의 버전 확인 명령(예: --version)으로 정상 설치됐는지 확인하세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Docker

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
$ docker pull kisspeter/apifuzzer:latest

이 명령어를 터미널에 그대로 입력해 실행하세요.

docker run --volume results:/results/ kisspeter/apifuzzer --src_url http://host.docker.internal:8000/openapi.json --url http://host.docker.internal:8000 --test_report /results/junit.xml --report /results/report/

빌드된 이미지를 실제 컨테이너로 실행합니다.

> * Define `--net` at startup to attach this docker to an existing network. Read [Docker cocumentation](https://docs.docker.com/network/network-tutorial-standalone/#use-user-defined-bridge-networks) for further explanation

이 명령어를 터미널에 그대로 입력해 실행하세요.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

4. Python

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).
pip3 install APIFuzzer

PyPI에 배포된 패키지를 바로 설치합니다. 소스 클론이 필요 없습니다.

$ pip3 install -r APIFuzzer/requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation