文档首页 > > 开发指南> 导入导出API> 导入API示例

导入API示例

分享
更新时间: 2019/08/06 GMT+08:00

导入HTTP类型后端服务API

包含IAM认证和请求参数编排的GET方法API定义,后端服务类型为HTTP。

swagger: "2.0"
info:
  title: "importHttpEndpoint10"
  description: "import apis"
  version: "1.0"
host: "api.account.com"
schemes:
  - "https"
basePath: "/"
paths:
  '/http/{userId}':
    get:
      operationId: "getUser3"
      description: "get user by userId"
      security:
        - IAM: []
      produces:
        - "application/json"
      parameters:
        - name: "test"
          description: "authorization token"
          type: "string"
          in: "header"
          required: true
        - name: "userId"
          description: "user id"
          type: "string"
          in: "path"
          required: true
      responses:
        "200":
          description: "user information"
      x-apigateway-request-type: "public"
      x-apigateway-cors: true
      x-apigateway-match-mode: "NORMAL"
      x-apigateway-backend:
        type: "HTTP"
        parameters:
          - name: "userId"
            value: "userId"
            in: "query"
            origin: "REQUEST"
            description: "user id"
          - name: "X-Invoke-User"
            value: "apigateway"
            in: "header"
            origin: "CONSTANT"
            description: "invoke user"
        httpEndpoints:
          address: "example.com"
          scheme: "http"
          method: "GET"
          path: "/users"
          timeout: 30000
securityDefinitions:
  IAM:
    type: "apiKey"
    name: "X-Auth-Token"
    in: "header"
    x-apigateway-auth-type: "IAM"

导入HTTP VPC类型后端服务API

包含APP认证和请求参数编排的ANY方法API定义,后端服务使用VPC通道。

swagger: "2.0"
info:
  title: "importHttpVpcEndpoint"
  description: "import apis"
  version: "1.0"
host: "api.account.com"
schemes:
  - "https"
basePath: "/"
paths:
  '/http-vpc':
    x-apigateway-any-method:
      operationId: "userOperation"
      description: "user operation resource"
      security:
        - APP: []
      parameters:
        - name: "Authorization"
          description: "authorization signature"
          type: "string"
          in: "header"
          required: true
      responses:
        "default":
          description: "endpoint response"
      x-apigateway-request-type: "public"
      x-apigateway-cors: true
      x-apigateway-match-mode: "SWA"
      x-apigateway-backend:
        type: "HTTP-VPC"
        parameters:
          - name: "X-Invoke-User"
            value: "apigateway"
            in: "header"
            origin: "CONSTANT"
            description: "invoke user"
        httpVpcEndpoints:
          name:
            - "userVpc"
          scheme: "http"
          method: "GET"
          path: "/users"
          timeout: 30000
securityDefinitions:
  APP:
    type: "apiKey"
    name: "Authorization"
    in: "header"
    x-apigateway-auth-type: "AppSigv1"

导入FUNCTION类型后端服务API

包含IAM认证和请求参数编排的GET方法API定义,后端服务类型为FunctionGraph。

swagger: "2.0"
info:
  title: "importFunctionEndpoint"
  description: "import apis"
  version: "1.0"
host: "api.account.com"
schemes:
  - "https"
basePath: "/"
paths:
  '/function/{name}':
    get:
      operationId: "invokeFunction"
      description: "invoke function by name"
      security:
        - IAM: []
      produces:
        - "application/json"
      parameters:
        - name: "X-Auth-Token"
          description: "authorization token"
          type: "string"
          in: "header"
          required: true
        - name: "name"
          description: "function name"
          type: "string"
          in: "path"
          required: true
      responses:
        "200":
          description: "function result"
      x-apigateway-request-type: "public"
      x-apigateway-cors: true
      x-apigateway-match-mode: "NORMAL"
      x-apigateway-backend:
        type: "FUNCTION"
        parameters:
          - name: "functionName"
            value: "name"
            in: "query"
            origin: "REQUEST"
            description: "funtion name"
          - name: "X-Invoke-User"
            value: "apigateway"
            in: "header"
            origin: "CONSTANT"
            description: "invoke user"
        functionEndpoints:
          function-urn: "your function urn address"
          version: "your function version"
          invocation-type: "async"
          timeout: 30000
securityDefinitions:
  IAM:
    type: "apiKey"
    name: "X-Auth-Token"
    in: "header"
    x-apigateway-auth-type: "IAM"

导入MOCK类型后端服务API

包含无认证的GET方法API定义,后端服务类型为MOCK。

swagger: "2.0"
info:
  title: "importMockEndpoint"
  description: "import apis"
  version: "1.0"
host: "api.account.com"
schemes:
  - "https"
basePath: "/"
paths:
  '/mock':
    get:
      operationId: "mock"
      description: "mock test"
      produces:
        - "application/json"
      responses:
        "200":
          description: "mock result"
      x-apigateway-request-type: "private"
      x-apigateway-cors: true
      x-apigateway-match-mode: "NORMAL"
      x-apigateway-backend:
        type: "MOCK"
        mockEndpoints:
          result-content: "{\"message\": \"mocked\"}"
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区