swaggerhub和REST API

时间:2018-06-19 13:18:47

标签: node.js swagger

我使用swaggerHub编写了新应用程序Node的文档,但是一个API出现了问题。

我的API需要两个参数。 示例:POST http://cloud.amazingwebsite.com/:service/:action

好吧,如果要使用此API,则必须提供两个值。我的问题是swaggerHub的文档仅提出了一个参数的示例。

请,您有一个包含两个参数的示例吗?可能吗 ?谢谢

1 个答案:

答案 0 :(得分:1)

如果您这样做:

  "/{service}/{action}":
    x-swagger-router-controller: serviceController
    post:
      summary: To perform an action
      operationId: serviceAction
      parameters:
      - name: service
        in: path
        required: true
        type: string
        description: Request Path Param for service
      - name: action
        in: path
        required: true
        type: string
        description: Request Path Param for Action
      responses:
        '200':
          description: Success
          schema:
            "$ref": "#/definitions/SuccessResponse"
        default:
          description: Error
          schema:
            "$ref": "#/definitions/ErrorResponse"
definitions:
  SuccessResponse:
    type: object
  ErrorResponse:
    required:
    - error
    properties:
      error:
        type: string