@4geit/swg-message-model 中文文档教程

Question

@4geit/swg-message-model

---

消息模型及其端点

Installation

1. A recommended way to install @4geit/swg-message-model is through npm package manager using the following command:

npm i @4geit/swg-message-model --save

或者使用 yarn 使用以下命令：

yarn add @4geit/swg-message-model

2. In your swagger file, you need to add a reference to the SwgMessageModel definition under the definitions property (e.g. /api/swagger/swagger.yaml) as below:

swagger: "2.0"
# ...
definitions:
  SwgMessageModel:
    $ref: ../../node_modules/@4geit/swg-message-model/swagger.yaml#/definitions/SwgMessageModel
# ...

3. SwgMessageModel also comes along with some endpoints you can expose to the API, to do so you will need to add a reference to the SwgMessageModel definition under the paths property (e.g. /api/swagger/swagger.yaml) as below:

swagger: "2.0"
# ...
paths:
  /message:
    $ref: ../../node_modules/@4geit/swg-message-model/swagger.yaml#/definitions/MessageListPath
  /message/{id}:
    $ref: ../../node_modules/@4geit/swg-message-model/swagger.yaml#/definitions/MessageItemPath
  /message/populate:
    $ref: ../../node_modules/@4geit/swg-message-model/swagger.yaml#/definitions/PopulatePath
# ...

并且您还需要将路径添加到 swg-message-model 的 controllers 文件夹 包，这样 swagger-node 就会找到相关的控制器来使用。 编辑文件 /config/default.yaml 并向属性 mockControllersDirs 和 controllersDirs 添加两个新路径，如下所示：

swagger:
  # ...
  bagpipes:
    _router:
      # ...
      mockControllersDirs:
        # ...
        - node_modules/@4geit/swg-message-model/mocks
        # ...
      controllersDirs:
        # ...
        - node_modules/@4geit/swg-message-model/controllers
        # ...