qcobjects-handler-openapi

    0.0.13 • Public • Published

    QCObjects Handler for Open API

    QCObjects Handler for Open API requests. This handler will allow you to make a dynamic url like https://example.com/openapi.json

    Instructions

    1. Install this dependency in your project using npm
    npm i --save qcobjects-handler-openapi
    1. In your config.json file, create the following paths
    {
      "backend": {
        "routes": [{
            "name": "OpenAPI3.JSON",
            "description": "Open API v3 JSON",
            "path": "^/openapi.json$",
            "microservice": "com.qcobjects.backend.microservice.openapi.json"
          },
          {
            "name": "OpenAPI3.YAML",
            "description": "Open API v3 YAML",
            "path": "^/openapi.yaml$",
            "microservice": "com.qcobjects.backend.microservice.openapi.yaml"
          }
        ]
      }
    }
    1. Start the QCObjects HTTP2 Server
    qcobjects-server
    1. Visit https://example.com/openapi.json to view the result

    Install

    npm i qcobjects-handler-openapi

    DownloadsWeekly Downloads

    7

    Version

    0.0.13

    License

    LGPL-3.0-or-later

    Unpacked Size

    25.9 kB

    Total Files

    16

    Last publish

    Collaborators

    • jeanmachuca