openapi gui

Openapi-gui

OpenApi-Gui는 OpenApi 버전 3.0.x JSON/YAML 정의를 작성하고 편집하기위한 GUI입니다. 현재 형태에서는 간단한 OpenAPI 정의를 시작하고 편집하는 도구로 가장 유용합니다. 가져온 OpenAPI 2.0 정의는 자동으로 v3.0으로 변환됩니다.

이전 Swagger / OpenApi 2.0 전용 버전은 여기를 참조하십시오. 이 버전은 현재 보안 수정과는 별도로 인정되지 않았습니다 .

이 프로젝트는 처음에는 Daryl Kuhn의 요오드 토르의 포크였으며, 그 결과 Ruby로 작성된 Brandon West의 Iodoctor에서 영감을 얻었습니다. 프로젝트의 완전한 역사는 Github에서 유지됩니다.

설명

작동 방식

업로드하려면 기존 OpenApi 2.0 또는 3.0.x 정의를 선택하거나 새로운 정의를 만들고 경로, 작업 및 매개 변수 추가를 시작하십시오. 기존 정의가 사용되면 구문 분석되며 각 경로를 편집하기위한 양식이 작성되며, 조작 및 매개 변수가 생성됩니다.

a ?url= 쿼리 매개 변수를 초기 시작 페이지에 추가하여 기존 정의를로드 할 수 있습니다. Docker를 사용할 때 url 쿼리 매개 변수의 값을 %2fserve 로 설정하여 Docker Commandline에서 전달한 정의를 선택할 수 있습니다.

편집을 시작하려면 왼쪽 메뉴에서 항목을 클릭하십시오. "내보내기"탭 중 하나를 선택하여 언제든지 JSON/YAML 출력을보십시오. 완료되면 출력을 다운로드하여 로컬로 저장하거나 클립 보드를 복사하십시오. OpenApi-Gui는 한 번에 하나의 정의 만 저장하며 이는 브라우저의 로컬 스토리지에 있습니다. JSON/YAML 출력을 로컬에서 저장하십시오.

파괴적인 행동을 수행하기 전에 Openapi-Gui는 정의의 현재 상태를 저장합니다. 다른 모든 시간에 수동으로 저장을 선택해야합니다.

기술

OpenApi-Gui는 CSS 용 Vue.js, JQuery 및 Bulma를 포함한 여러 JavaScript 프레임 워크를 사용하여 완전히 클라이언트 측면을 실행합니다.

앱을 UP 및 실행하려면 GitHub 페이지의 라이브 버전으로 탐색하거나 GitHub 페이지에 클론을 배포하거나 아래 버튼을 사용하여 Heroku에 배포하거나 repo를 복제하고 Browser를 index.html 에서 포인하거나 직접 호스트 할 수 없습니다. 더 많은 기술 정보는 여기에 있습니다.

openapi-gui Embedded Web Server (예 : 자신의 웹 서버를 실행하는 경우)를 사용하려는 경우 Node.js 모듈 만 npm install 하면됩니다.

CLI 옵션

 -d, --definition    serve the given OAS definition
-l, --launch        start a web-browser pointing to the GUI
-p, --port          specify the port to run on, defaults to $PORT or 3000
-w, --write         enable writing back to the source definition

Docker와 함께 달리기

로컬 노드 개발 환경이 없거나 Docker 컨테이너에서 OpenApi-Gui를 실행하는 것을 선호하는 경우 몇 가지 간단한 단계로 수행 할 수 있습니다.

1. 저장소를 복제하십시오.
2. docker build -t mermade/openapi-gui . Docker Image ( mermade/openapi-gui )를 구축하려면
3. docker run --name openapi-gui -p 8080:3000 -d mermade/openapi-gui 포트 8080에서 서버를 실행하십시오.
4. 좋아하는 브라우저에서 http://localhost:8080 으로 이동하십시오.
5. 완료되면 docker stop openapi-gui && docker rm openapi-gui 실행하여 서버를 종료하십시오.

또는 사전 구축 된 Docker 이미지를 가져올 수 있습니다.

• docker pull mermade/openapi-gui

제한

• OpenApi-Gui는 공유 매개 변수를 회의 할 것입니다.
• 정의는 외부 $ref s가없는 상태에서 독립적이어야합니다. 이것은 곧 해결 될 것입니다 (Ho-Ho) .
• 응답 / 예제 / 신체 스키마 편집은이를 회의합니다.
• OpenApi-Gui는 매개 변수가 삭제되고 재생되는 경우 항상 공급 업체-확장을 보존하지는 않습니다.
• OpenApi-Gui는 YAML 형식으로 가져온 정의에서 의견을 보존하지 않습니다.

TODO

• OpenAPI 3.0 사양 지원의 현재 상태를 참조하십시오.