Swagger-Hub 와 API서버 연동 하기

swagger-hub editor로 yml 스크립트를 어찌 짜야하는지 도통 몰라 이것저것 만져보고

수정하고 겁나 헤딩하며 대충 감만 잡았다.

중요한 건 내가 만든 springboot2 restapi 서버 쪽으로 어떻게 연결하느냐 였다...

항상 헤딩하며 느끼는 거지만 알고 나면 진짜 아무것도 아닌 거 더라는;;;;

yml 작성 법은 차차 알아 가는 걸로;;;

 

아래 yml스크립트로 swagger-hub에 명시한 API는 userid/password를 jsonData로 전달하면 response시 jsonData로 암호화된 userid/password를 Return 한다.

openapi: 3.0.0
# Added by API Auto Mocking Plugin
servers:
# Added by API Auto Mocking Plugin
  - description: SwaggerHub API Auto Mocking
    url: http://XXX.XXX.XXX.XXX:8080/supord  //-->이부분이 연동할 API서버 주소가 들어 가는부분이다.
                                             //    서비스명(context) 까지 넣어 주면 된다.
info:
  description: This is a Test API
  version: "v1"
  title: Simple cryptoTest API
  contact:
    email: tenpest@naver.com
  license:
    name: Apache 2.0
    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
  - name: developers
    description: Operations available to regular developers
paths:
  /v1/api/cryptoTest:    //-->이부분은 controller에 정의한 url을 적으면 된다.
    post:
      tags:
        - developers
      summary: 아이디/패스워드 암호화 API
      operationId: cryptoTest
      description: |
        By passing in the appropriate options, you can search for
        available inventory in the system
      requestBody:
          description: search requestBody
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/JwtRequest' //-->request시보낼 파라메터 
                                                            //또는 오브젝트이며 아래 schemas 항목에 정의 하고 사용해야 한다.
        
      responses:
        '200':
          description: Return respons Body
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/JwtResponse'//-->response시 Data 아래 schemas 항목에 정의 하고 사용해야 한다.
        '400':
          description: bad input parameter
components: //--> 요부분 부터가 위에 $ref 로 링크 된 오브젝트 명세 작성 부분이다.
              //    참고로 나의 경우 request와 response 200ok에 대한 오브젝트만 설정 했다.
  schemas:
    JwtRequest:
      required:
        - userid
        - password
      properties:
        userid:
          type: string
        password:
          type: string
    JwtResponse:
      required:
        - userid
        - password
      properties:
        userid:
          type: string
        password:
          type: string

1. 위의 yml스크립트만 작성한 상태일 때

Example Value에 json포멧이 [ ] array 형식으로 감싸져 있는데 이유를 모르겠다;;;테스트시에는 [ ]를 삭제 하고 하니 정상 동작 하였다.

 

2. Try it Out (Execute)

나는 귀찬아서 그냥 파라메터를 string/string상태로 호출해 봤다 ㅋㅋ

3. response 결과

음 머 암호화만 하는거니까 잘되어서 온다 ㅎㅎ