Install guide

설치를 위한 환경 만들기

사용을 위한 환경 섹션에서 필요한 패키지를 설치합니다.
프로젝트 사용을 위하여 꼭 필요한 프로그렘들이므로 설치하고 사용할 수 있는 환경을 만들어줍니다.

빠른 테스트 예제확인을 위하여 nginx나 apache를 사용하지 않고, php로 서버구동 하도록 하겠습니다.

서버환경 정의

mysql 관리 프로그램이나 콘솔에서 데이터베이스 추가와 사용자 등록을 해줍니다. 설치 예제를 위하여 다음과 같이 설정했습니다.

로컬서버 정보

• url: http://localhost
• port: 8000

mysql db 정보

• host: localhost
• port: 3306
• database: goose_test
• username: goose_test
• password: 1234

프로젝트 인스톨

프로그램을 사용할 장소로 이동하여 다음과 같이 실행하여 프로젝트를 클론합니다.

git clone https://github.com/redgoose-dev/goose-api.git

클론이 끝났으면 프로젝트 내부로 이동하여 composer install 명령으로 벤더들을 설치합니다.

cd goose-api
composer install

다음을 실행하여 .env파일을 만듭니다.

./script.sh ready

.env 파일이 만들어졌다면 내용을 편집합니다.

vi .env
nano .env

.env 파일에서 다음 내용을 참고하여 편집합니다. 우선 작동을 위하여 필요한 항목만 수정합니다.
.env의 항목에 대한 가이드는 .env 항목 가이드 페이지를 참고해주세요.

PATH_URL=http://localhost:8000
PATH_RELATIVE=/

DB_HOST=localhost
DB_PORT=3306
DB_DATABASE=goose_test
DB_USERNAME=goose_test
DB_PASSWORD=1234

.env 파일 수정이 끝났으면 저장하고 다음 명령어를 실행하여 본격적인 인스톨을 실행합니다.

./script.sh install

인스톨이 끝나면 공개용 토큰값과 root 계정정보가 적힌것을 참고합니다.

서버 실행하기

다음 명령어를 실행하여 php로 서버를 실행합니다.

./script.sh start

브라우저에서 http://localhost:8000로 접속하면 json 형태의 결과값이 출력되는것을 확인할 수 있습니다.
Authorization 관련 오류가 출력되는데 API 클라이언트(paw, postman)를 통하여 Headers 영역에서 Authorization키를 만들어서 값은 인스톨이 끝났을때 출력된 토큰값을 입력해서 실행합니다.

API 클라이언트에서 다시 요청을 해보면 200코드로 된 결과값을 확인하면

공개용 토큰 만들기

로그인을 할때 만들어지는 유저용 토큰과 공개용 토큰을 사용합니다.

토큰은 .env에서 TOKEN_KEY, TOKEN_ID, PATH_URL 값에 의해서 변하기 때문에 수정하면 토큰을 다시 만들어 줘야합니다. 공개용 토큰을 만드는 명령은 다음과 같습니다.

./script.sh make-token

문제 해결하기

인증관련 오류발생

만약 Authorization error관련 메시지가 보인다면 토큰을 만든시점(인스톨)후에 .env에서 TOKEN_KEY, TOKEN_ID, PATH_URL 값이 변해서 다른 토큰을 사용해야 합니다.

다음과 같은 명령을 실행하면 새로운 공개용 토큰을 만들 수 있습니다.

./script.sh make-token