挥舞着错误:ptr必须是JSON指针

时间:2019-03-18 01:20:38

标签: javascript java express swagger openapi

我正在尝试运行我的swagger文件,但不断出现此错误。

Error: ptr must be a JSON Pointer
    at pathFromPtr (/Users/salma/Desktop/swaggerIntegration/node_modules/json-refs/index.js:1128:11)
    at /Users/salma/Desktop/swaggerIntegration/node_modules/json-refs/index.js:293:45
    at process.runNextTicks [as _tickCallback] (internal/process/next_tick.js:47:5)
    at Function.Module.runMain (internal/modules/cjs/loader.js:800:11)
    at executeUserCode (internal/bootstrap/node.js:526:15)
    at startMainThreadExecution (internal/bootstrap/node.js:439:3)

这是我的招摇文件

swagger: "2.0"
info:
  version: "0.0.1"
  title: employees DB
# during dev, should point to your local machine
host: localhost:10010
# basePath prefixes all resource paths 
basePath: /
# 
schemes:
  # tip: remove http to make production-grade
  - http
  - https
# format of bodies a client can send (Content-Type)
consumes:
  - application/json
# format of the responses to the client (Accepts)
produces:
  - application/json
paths:
  /employees:
    # binds a127 app logic to a route
    x-swagger-router-controller: employees
    get:
      description: Returns 'Hello' to the caller
      # used as the method name of the controller
      operationId: index
      parameters:
        - name: name
          in: query
          description: The name of the person to whom to say hello
          required: false
          type: string
      responses:
        "200":
          description: Success
          schema:
            # a pointer to a definition
            $ref: "#/definitions/employeesListBody"
        # responses may fall through to errors
        default:
          description: Error
          schema:
            $ref: "#/definitions/ErrorResponse"
  /swagger:
    x-swagger-pipe: swagger_raw
# complex objects have schema definitions
definitions:
  employeesListBody:
    required:
      - employees
    properties:
      employees:
        type: array
        items:
          $ref: "#definitions/Employee"

  Employee:
    required:
      - name
      - email
      - position
    properties:
        name:
          type: string
        email:
          type: string
        position:
          type: string
        age:
          type: integer
          minimum: 20
          
  ErrorResponse:
    required:
      - message
    properties:
      message:
        type: string

有什么解决办法吗? 有没有更简单的方法来美化招摇文件?因为我得到很多解析错误。 还有没有人有将swagger与express和mongodb一起使用的好例子吗? 非常感谢。

1 个答案:

答案 0 :(得分:0)

其中一个参考在/之后缺少#

$ref: "#definitions/Employee"

将其更改为:

$ref: "#/definitions/Employee"
#       ^


如果将定义粘贴到http://editor.swagger.io中,它将显示错误的确切位置。

Syntax validation in Swagger Editor