source2swagger가 포함 된 정적 API 문서

Question

source2swagger는 하나의 json 파일에 모든 api를 가진 swagger spec을 생성합니다. 정말 그걸 사용 할까? swagger-ui로 생성 된 json 파일을 탐색 할 때 단일 json 파일에서 설명/작업을 사용하는 대신 API 경로를 사용하여 API 설명을 읽으려고합니다.

Answer 1

Swagger-UI는 모든 json을 하나의 파일에 넣는 것을 처리합니다. 비록 여러 최상위 리소스 목록이있을 수 있는지 아직 확실하지 않습니다.

{"basePath":"http://localhost:3001/", "resourcePath":"/", "swaggerVersion":"1.1", "apiVersion":"1.0", "apis":[ 
    { 
     "path":"/pay", 
     "format":"json", 
     "description":"Create a transaction with the given amount and token.", 
     "operations":[ 
      { 
       "httpMethod":"GET", 
       "tags":["production"], 
       "nickname":"pay", 
       "deprecated":false, 
       "summary":"Create a transaction with the given amount and token.", 
       "parameters":[ 
        { 
         "name":"token", 
         "description":"The token representing the pay card", 
         "dataType":"string", 
         "allowMultiple":false, 
         "required":true, 
         "paramType":"query" 
        }, 
        { 
         "name":"amount", 
         "description":"The amount to pay", 
         "dataType":"string", 
         "allowMultiple":false, 
         "required":true, 
         "paramType":"query" 
        } 
       ] 
      } 
     ] 
    }, 
    { 
     "path":"/customer", 
     "format":"json", 
     "description":"Create an HTML form for adding a customer.", 
     "operations":[ 
      { 
       "httpMethod":"GET", 
       "tags":["production"], 
       "nickname":"createCustomerForm", 
       "deprecated":false, 
       "summary":"Create an HTML form for adding a customer.", 
       "parameters":[ 
        { 
         "name":"customerId", 
         "description":"Your customer id", 
         "dataType":"string", 
         "allowMultiple":false, 
         "required":true, 
         "paramType":"query" 
        } 
       ] 
      } 
     ] 
    }, 
    { 
     "path":"/customer/{customerId}", 
     "format":"json", 
     "description":"Delete the customer info for given id.", 
     "operations":[ 
      { 
       "httpMethod":"DELETE", 
       "tags":["production"], 
       "nickname":"deleteCustomer", 
       "deprecated":false, 
       "summary":"Delete the customer info for given id.", 
       "parameters":[ 
        { 
         "name":"customerId", 
         "description":"the customer id to delete", 
         "dataType":"string", 
         "allowMultiple":false, 
         "required":true, 
         "paramType":"path" 
        } 
       ] 
      } 
     ] 
    }, 
    { 
     "path":"/card", 
     "format":"json", 
     "description":"Create an HTML form for adding a credit card.", 
     "operations":[ 
      { 
       "httpMethod":"GET", 
       "tags":["production"], 
       "nickname":"createCardForm", 
       "deprecated":false, 
       "summary":"Create an HTML form for the given customer to add a credit card.", 
       "parameters":[ 
        { 
         "name":"customerId", 
         "description":"Your customer id", 
         "dataType":"string", 
         "allowMultiple":false, 
         "required":true, 
         "paramType":"query" 
        } 
       ] 
      } 
     ] 
    }, 
    { 
     "path":"/card/{token}", 
     "format":"json", 
     "description":"Delete a card record by token.", 
     "operations":[ 
      { 
       "httpMethod":"DELETE", 
       "tags":["production"], 
       "nickname":"deleteCard", 
       "deprecated":false, 
       "summary":"Delete the card info for given token.", 
       "parameters":[ 
        { 
         "name":"token", 
         "description":"the token to delete", 
         "dataType":"string", 
         "allowMultiple":false, 
         "required":true, 
         "paramType":"path" 
        } 
       ] 
      } 
     ] 
    } 
]} 

: 여기

는 작업 예제