Insomnia API Document 사용법 [API 문서화 도구]

서버 작업을 하다보면 필수적으로 API 테스트를 진행하게 됩니다. API 테스트 툴로는 POSTMAN이 가장 많이 사용되지만, 프로그램 자체가 무거운 감이 없지 않아, Insomnia로 갈아탔습니다.

API를 다 테스트 한 뒤 프론트를 작업하시는 분께 API를 어떻게 사용해야 하는지, 대략적으로 보여줘야 하는데, 정식 문서를 작성하기 전 개발용 API 문서를 생성할 수 있습니다.

 

 

Insomnia API 문서 만들기

 

① 우선 테스트한 API 데이터들을 출력해줍니다.

 

 

문서로 출력할 API를 선택한 후,  

 

 

JSON 형식으로 데이터를 Export 해줍니다.

 

Insomia API 문서 렌더링

 

저는 API Test 데이터를 testAPI.json이라는 이름으로 저장했습니다.

이제 저장된 디렉토리로 이동하셔서 아래 명령어를 입력해줍니다. JSON으로 출력된 데이터들을 기반으로 HTML 형식의 렌더링 파일들을 생성해줍니다.

-o 옵션을 주면 출력되는 폴더명을 지정할 수 있습니다. 저는 API-Folder라는 이름으로 지정했습니다.

$ npx insomnia-documenter --config testAPI.json --output API-Folder

 

 

API-Folder에 들어가보시면 html파일과 css 파일등 렌더링에 필요한 파일들이 생성되어 있습니다.

 

이제 API-Folder 디렉토리로 이동한 후 아래 명령어를 입력하시면 서버가 작동되고, API 문서를 확인할 수 있습니다.

$ npx serve

 

 

 

 

Artillery 부하테스트 사용 방법 [Node.js test]

 

[회고록] 코드스테이츠 프로젝트 DID 인증 서비스의 가치는?

 

Javascript 함수 실행시간 timer 사용법 시간 측정