swagger(OpenAPI)로 간단 mock 디버그

3261 단어 swaggerOpenAPI

개요



Swagger3.0(OpenAPI3.0)을 사용해 간단하게 mock를 세워 디버그해 갑니다.
NodeJS라든지 사용하지 않습니다※이므로, 간편하게 할 수 있을까 생각합니다.

※ 코드 제너레이터를 사용하는 경우에도, OnlineEditor( htps : // 에아와 r. 슈게 r. 이오/ ) 로부터 하면, NodeJS라든지는 필요 없습니다.

이미 Swagger2.X에서 작동하는 경우



htps : //오페나피-응ゔぇr r. 어리석은 p. 코m/
여기에서 변환하십시오.
현재(2018/9)Swagger3.0(OpenAPI3.0)이 rc판이 되고 있으므로, 멍하니 대응하기 시작해도 좋은 것은 아닐까요?

준비하는 것



VSCode




htps : // 여기.ゔぃ ああ ls つぢ오. 코m/

공식 SwaggerEditor도 있습니다만, 무겁고 조작성이 나쁘기 때문에 VSCode를 추천합니다.
플러그인으로 다음을 설치하십시오.
  • openapi-lint
  • openapi-viewer
  • YAML Support by Red Hat

  • APIsprout




    htps : // 기주 b. 코 m / danee lg y y r / api sp 로우 t

    쉽게 mock을 세우는 도구입니다.
    go의 환경 들어가면 go get으로 install 할 수 있습니다만, 이하의 방법으로도 할 수 있는 것 같습니다. (검증되지 않음)

    YAML 준비



    이미 있거나 자동 생성된 경우 건너뛰십시오.

    쓰는 방법은 여기에 실려 있습니다.
    htps : // 기주 b. 코m/오이/오페나피-S페시후카치온/bぉb/마s테r/ゔぇr시온s/3.0.1. md

    처음부터 전부 읽지 않고, 이쪽으로부터 복사해 가면 좋다고 생각합니다.
    htps : // 기주 b. 코 m/오아이/오페나피-S페시후카치온/t레에/마s테r/에아mpぇs/v3.0

    mock의 response가 되는 값을 넣는다



    mock 디버깅을 할 때 각 매개 변수의 example이 그대로 값이되어 들어오므로
    이쪽을 참고로 값을 넣어 주세요.
    htps : // 기주 b. 코m/오이/오페나피-S페시후카치온/bぉb/마s테r/ゔぇr시온s/3.0.1. md #에에mpぇ오 b지ぇct

    이런 식으로 json을 페탓으로 붙인 것을 example에도 할 수 있습니다.

    가능하면 공식 참고 코드처럼 매개 변수별로 작성하는 것이 좋습니다.
    일회용 전제 같은 사용법을 할 경우 SwaggerUI의 response를 복사하여 성형도 개미입니다.

    SwaggerUI에서 확인



    VSCode에서 YAML을 연 상태에서
  • ⇧⌘P
  • OpenAPI:Preview

  • 로 표시할 수 있습니다.
    YAML에 익숙해지면 SwaggerUI에서
    response json을 확인하거나 curl 명령을 생성 할 때 열릴 정도가 될 것이라고 생각합니다.

    APIsprout에서 mock 시작



    다음 명령을 실행하기만 하면 됩니다.
    $ apisprout [YAMLファイルのパス]
    

    완성!!
    기본 포트는 8000입니다.

    좋은 웹페이지 즐겨찾기