@4geit/swg-hello-path 中文文档教程

Question

@4geit/swg-hello-path

---

添加一个在你的 api 中启用 hello world 端点的虚拟路径

Installation

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

npm i @4geit/swg-hello-path --save

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

yarn add @4geit/swg-hello-path

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

swagger: "2.0"
# ...
paths:
  /hello:
    $ref: ../../node_modules/@4geit/swg-hello-path/swagger.yaml#/definitions/SwgHelloPath
# ...

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

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