insomnia documenter

Postman Documenter와 비슷하지만 불면증에 적합합니다! 이 도구를 사용하면 Insomnia 내보내기 파일을 사용하여 아름다운 API 문서 페이지를 생성할 수 있습니다.

데모: https://insodoc.github.io/insomnia-docuenter/
튜토리얼 및 데모 비디오: https://www.youtube.com/watch?v=pq2u3FqVVy8

목차

• 목차
• 요구사항
• 시작하기
  • npx 사용
  • 패키지를 전역적으로 설치하여
  • 옵션
  • GitHub 릴리스 사용
• API 업데이트
• 사용자 정의 루트 경로
• 로컬에서 페이지 실행
• 불면증 플러그인
• 변경 내역
• 기부금
• 특허
• 기업용 불면증 Documenter

요구사항

• Node.js(8.x 이상 권장)
• 내보낸 불면증 작업 영역 JSON(v4)

시작하기

Insomnia Documenter는 문서 페이지를 매우 쉽게 설정할 수 있는 CLI 도구를 제공합니다. 두 가지 방법으로 사용할 수 있습니다.

npx 사용

npx insomnia-documenter --config /path/to/insomnia/config.json

패키지를 전역적으로 설치하여

npm i -g insomnia-documenter
insomnia-documenter --config /path/to/insomnia/config.json

옵션

 Options:
  -c, --config <location>  Location of the exported Insomnia JSON config.
  -l, --logo <location>    Project logo location (48x48px PNG).
  -f, --favicon <location>    Project favicon location (ICO).
  -o, --output <location>  Where to save the file (defaults to current working directory).
  -h, --help               output usage information

GitHub 릴리스 사용

또는 GitHub에서 릴리스 아카이브를 다운로드하고 insomnia.json 내보내기 파일을 사이트의 루트 디렉터리에 추가하여 Insomnia Documenter 사용을 시작할 수 있습니다.

API 업데이트

API 업데이트는 매우 간단합니다! Insomnia Documenter는 플러그 앤 플레이 웹 앱이므로 insomnia.json 새로 내보낸 JSON 파일로 바꾸면 됩니다. 이름이 insomnia.json 인지 확인하세요.

실제로 로고( logo.png )와 파비콘( favicon.ico )에도 동일하게 적용됩니다.

사용자 정의 루트 경로

동일한 도메인에 여러 API를 문서화하고 싶으신가요? GitHub 페이지에 문서 페이지를 호스팅하고 싶으신가요? 이 경우(다른 많은 경우) 루트 경로가 무엇인지 지정해야 합니다. 이렇게 하려면 index.html 열고 다음 줄을 바꿔야 합니다.

 < div id =" app " > </ div >

다음과 같이 :

 < div id =" app " data-root =" /path/to/docs " > </ div >

이 경우 앱은 /path/to/docs 디렉터리에서 insomnia.json 파일을 선택합니다. 이를 통해 문서 페이지를 유지 관리하는 방법에 대해 더 많은 유연성을 제공합니다(예를 들어 웹 페이지의 루트 디렉터리가 아닌 다른 위치에 내보내기 파일을 저장할 수 있음). data-root 속성에 후행 슬래시를 넣으면 안 됩니다.

이 속성을 설정해도 페이지의 파비콘과 로고에는 영향을 미치지 않습니다. index.html 있는 동일한 디렉토리에서 계속 로드됩니다.

로컬에서 페이지 실행

index.html 파일을 열면 99.9%의 경우 로드에 실패합니다. 이것이 바로 가져오기 작동 방식이기 때문입니다. 페이지를 로컬에서 미리 보려면 zeit/serve와 같은 도구를 사용할 수 있습니다.

npx serve

해당 페이지는 http://localhost:5000에서 사용할 수 있습니다.

불면증 플러그인

devhammed는 Insomnia의 인터페이스에서 직접 문서 페이지를 생성할 수 있는 멋진 Insomnia 플러그인을 만들었습니다. 플러그인 받기 (npm - github)

변경 내역

변경 로그 문서를 참조하세요.

기부금

CLI 도구는 명령 애플릿인 반면 프런트엔드 자체는 Svelte 앱입니다. 이 프로젝트는 아직 베타 버전이므로 버그가 있고 여기저기서 개선될 수 있습니다. 기여를 환영합니다 :)

저장소를 복제합니다.

git clone [email protected]:jozsefsallai/insomnia-documenter.git
cd insomnia-documenter

종속성을 설치합니다.

npm install

데모 불면증 내보내기 파일을 복사합니다.

cp docs/insomnia.json public/insomnia.json

핫 리로드로 개발 빌드를 실행합니다.

npm run dev

프로덕션 빌드를 생성합니다.

npm run build

린팅:

npm run lint

테스트:

npm run test 

특허

MIT.

참고: 이 프로젝트는 Kong 및/또는 Insomnia와 관련이 없습니다.

기업용 불면증 Documenter

Tidelift 구독의 일부로 사용 가능

Insomnia Documenter 및 수천 개의 다른 패키지의 관리자는 Tidelift와 협력하여 애플리케이션을 구축하는 데 사용하는 오픈 소스 종속성에 대한 상업적 지원 및 유지 관리를 제공하고 있습니다. 시간을 절약하고 위험을 줄이며 코드 상태를 개선하는 동시에 사용하는 정확한 종속성에 대한 비용을 관리자에게 지불합니다. 자세히 알아보세요.