@accility/protoc-swagger-plugin/README.md

Convert .proto files to OpenAPI v2 (swagger) files.

# .proto to OpenApi Conversion

:warning: This package is still in early days and the interfaces might change back and forth. When stable enough it will be released as v1.0.

Generate [OpenAPI v2 (Swagger)](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) files from [.proto](https://developers.google.com/protocol-buffers) files.

This package includes the [protoc-gen-swagger plugin](https://github.com/grpc-ecosystem/grpc-gateway/releases) from the [grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway) project.
It also makes available the collection of the [google common protos](https://github.com/googleapis/api-common-protos.git).

## Installing

```bash
npm install -D @accility/protoc-tools
```

## Usage

```javascript
const protoc = require('@accility/protoc-tools');
const swagger = require('@accility/protoc-swagger-plugin');
const apis = require('google-proto-files');
const path = require('path');

tools.protoc({
    includeDirs: [
        path.resolve(apis.getProtoPath(), '..'),
        path.resolve('./test/protos')
    ],
    files: ['product.proto'],
    outDir: path.resolve(__dirname, 'generated'),
    outOptions: [
        swagger.createSwaggerOptions({ outOptions: 'logtostderr=true' }),
        tools.generators.js(),
    ]
});
```

Or with the shorthand protoc-swagger-wrapper

```javascript
const swagger = require('@accility/protoc-swagger-plugin');
const path = require('path');

// The .proto-files from the package google-proto-files is automatically added
// to the include paths since we always need the REST annotations when
// converting from .proto to OpenApi.
swagger.fromProto({
    includeDirs: [path.resolve('./test/protos')],
    files: ['product.proto'],
    outDir: path.resolve(__dirname, 'generated')
});
```