# pip-services3-swagger-node > Portable abstractions and patterns for Pip.Services in Node.js Latest version **3.0.1** (published 2021-02-24) · MIT license · 0 weekly downloads ## Install ```sh npm install pip-services3-swagger-node pnpm add pip-services3-swagger-node yarn add pip-services3-swagger-node bun add pip-services3-swagger-node ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; large bundle. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.0.1 | | Published | 2021-02-24 | | First published | 2021-02-23 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=0.6.14 | | Dependencies | 3 | | Unpacked size | 17.8 MB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Conceptual Vision Consulting LLC | | Maintainers | seroukhov | | Keywords | pip.services, microservice, commons, library | ## Links - npm: https://www.npmjs.com/package/pip-services3-swagger-node - Repository: https://github.com/pip-services3-node/pip-services3-commons-node - Homepage: https://github.com/pip-services3-node/pip-services3-commons-node#readme - Issues: https://github.com/pip-services3-node/pip-services3-commons-node/issues - npm.io page: https://npm.io/package/pip-services3-swagger-node ## Dependencies (3) - [pip-services3-rpc-node](https://npm.io/package/pip-services3-rpc-node.md) ^3.5.0 - [pip-services3-commons-node](https://npm.io/package/pip-services3-commons-node.md) ^3.0.0 - [pip-services3-components-node](https://npm.io/package/pip-services3-components-node.md) ^3.0.0 ## Recent versions - 3.0.1 (latest) — 2021-02-24 - 3.0.0 — 2021-02-23 ## README # Pip.Services Logo
Swagger UI for Node.js This module is a part of the [Pip.Services](http://pipservices.org) polyglot microservices toolkit. The swagger module provides a Swagger UI that can be added into microservices and seamlessly integrated with existing REST and Commandable HTTP services. The module contains the following packages: - **Build** - Swagger service factory - **Services** - Swagger UI service Quick links: * [Change Log](CHANGELOG.md) * [Get Help](https://www.pipservices.org/community/help) * [Contribute](https://www.pipservices.org/community/contribute) ## Use Install the NPM package as ```bash npm install pip-services3-swagger-node --save ``` Develop a RESTful service component. For example, it may look the following way. In the `register` method we load an Open API specification for the service. You can also enable swagger by default in the constractor by setting `_swaggerEnable` property. ```typescript export class MyRestService extends RestService { public constructor() { super(); this._baseRoute = "myservice"; this._swaggerEnable = true; } private greeting(req, res) { let name = req.params.name; let response = "Hello, " + name + "!"; this.sendResult(req, res)(null, response); } public register() { this.registerRoute( 'get', '/greeting', new ObjectSchema(true) .withRequiredProperty("name", TypeCode.String), this.greeting ); this.registerOpenApiSpecFromFile('./src/services/myservice.yml'); } } ``` The Open API specification for the service shall be prepared either manually or using [Swagger Editor](https://editor.swagger.io/) ```yaml openapi: '3.0.2' info: title: 'MyService' description: 'MyService REST API' version: '1' paths: /myservice/greeting: get: tags: - myservice operationId: 'greeting' parameters: - name: correlation_id in: query description: Correlation ID required: false schema: type: string - name: name in: query description: Name of a person required: true schema: type: string responses: 200: description: 'Successful response' content: application/json: schema: type: 'string' ``` Include Swagger service into `config.yml` file and enable swagger for your REST or Commandable HTTP services. Also explicitely adding HttpEndpoint allows to share the same port betwee REST services and the Swagger service. ```yaml --- ... # Shared HTTP Endpoint - descriptor: "pip-services:endpoint:http:default:1.0" connection: protocol: http host: localhost port: 8080 # Swagger Service - descriptor: "pip-services:swagger-service:http:default:1.0" # My RESTful Service - descriptor: "myservice:service:rest:default:1.0" swagger: enable: true ``` Finally, remember to add factories to your container, to allow it creating required components. ```typescript ... import { DefaultRpcFactory } from 'pip-services3-rpc-node'; import { DefaultSwaggerFactory } from 'pip-services3-swagger-node'; export class MyProcess extends ProcessContainer { public constructor() { super("myservice", "MyService microservice"); this._factories.add(new DefaultRpcFactory()); this._factories.add(new DefaultSwaggerFactory()); this._factories.add(new MyServiceFactory()); ... } } ``` Launch the microservice and open the browser to open the Open API specification at [http://localhost:8080/greeting/swagger](http://localhost:8080/greeting/swagger) Then open the Swagger UI using the link [http://localhost:8080/swagger](http://localhost:8080/swagger). The result shall look similar to the picture below. ## Develop For development you shall install the following prerequisites: * Node.js 8+ * Visual Studio Code or another IDE of your choice * Docker * Typescript Install dependencies: ```bash npm install ``` Compile the code: ```bash tsc ``` Run automated tests: ```bash npm test ``` Generate API documentation: ```bash ./docgen.ps1 ``` Before committing changes run dockerized build and test as: ```bash ./build.ps1 ./test.ps1 ./clear.ps1 ``` ## Contacts The Node.js version of Pip.Services is created and maintained by: - **Sergey Seroukhov** --- _Source: https://npm.io/package/pip-services3-swagger-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._