swagger & api & swagger ui

[xgqfrms]

swagger & api & swagger ui

https://www.cnblogs.com/xgqfrms/p/9808520.html

[xgqfrms]

error

bug

Error initializing middleware
Error: Swagger document(s) failed validation so the server cannot start

swagger-api/swagger-node#354

[xgqfrms]

solution

solution

$ cd ./api/swagger && swagger validate swagger.yaml

---

https://stackoverflow.com/questions/37435400/not-a-valid-parameter-definition-swagger-json

http://23.22.16.221/v2/schema.json#

https://npmdoc.github.io/node-npmdoc-swagger-tools/build/apidoc.html

[xgqfrms]

- & yaml bug

missing - symbol bug

[xgqfrms]

Error

http://localhost:8080/users?user=xgqfrms

{
    "message": "Cannot read property 'value' of undefined"
}

http://localhost:8080/users?name=xgqfrms

{
    "message": "Cannot read property 'value' of undefined"
}

OK

http://127.0.0.1:8080/hello?name=xgqfrms

{
    "message": "Hello, xgqfrms!"
}

[xgqfrms]

https://swagger.io/
https://swagger.io/solutions/api-documentation/

http://swagger.io/v2/schema.json
https://swagger.io/v2/schema.json

[xgqfrms]

OK

object

Error

undefined ??? in-valid

[xgqfrms]

Error: Response validation failed: failed schema validation

https://github.com/swagger-api

[xgqfrms]

https://github.com/swagger-api/swagger-js
https://github.com/swagger-api/swagger-samples

https://github.com/swagger-api/swagger-node

[xgqfrms]

bug ???

swagger-api/swagger-node#578

[xgqfrms]

solution

why ???

modify config default.yaml

   validateResponse: false

# swagger configuration file

# values in the swagger hash are system configuration for swagger-node
swagger:

  fittingsDirs: [ api/fittings ]
  defaultPipe: null
  swaggerControllerPipe: swagger_controllers  # defines the standard processing pipe for controllers

  # values defined in the bagpipes key are the bagpipes pipes and fittings definitions
  # (see https://github.com/apigee-127/bagpipes)
  bagpipes:

    _router:
      name: swagger_router
      mockMode: false
      mockControllersDirs: [api/mocks]
      controllersDirs: [api/controllers]

    _swagger_validate:
      name: swagger_validator
      validateResponse: false
      # validateResponse: true

    # pipe for all swagger-node controllers
    swagger_controllers:
      - onError: json_error_handler
      - cors
      - swagger_security
      - _swagger_validate
      - express_compatibility
      - _router

    # pipe to serve swagger (endpoint is in swagger.yaml)
    swagger_raw:
      name: swagger_raw

# any other values in this file are just loaded into the config for application access...

[xgqfrms]

// http://localhost:8080/users?user=xgqfrms

{
    "users": "Hello, xgqfrms!"
}

// http://localhost:8080/users?name=xgqfrms

{
    "users": "Hello, stranger!"
}