document optional swagger plugin for unannotated grpc_api_configurati…

…on (#1588) * add the optional swagger plugin add `--swagger_out` reference to issue #1578 * Update docs/_docs/grpcapiconfiguration.md Co-authored-by: Johan Brandhorst-Satzkorn <[email protected]> Co-authored-by: Johan Brandhorst-Satzkorn <[email protected]>
grpc-ecosystem · Aug 12, 2020 · f3b7d47 · f3b7d47
1 parent 37837bc
commit f3b7d47
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/docs/_docs/grpcapiconfiguration.md b/docs/_docs/grpcapiconfiguration.md
@@ -64,4 +64,11 @@ The following is equivalent to the basic [usage example](usage.html) but without
    
    This will generate a reverse proxy `gen/go/your/service/v1/your_service.pb.gw.go` that is identical to the one produced for the annotated proto.
 
+6. Generate the optional your_service.swagger.json
+
+    ```sh
+    protoc -I. --swagger_out=grpc_api_configuration=path/to/your_service.yaml:./gen/go \
+      your/service/v1/your_service.proto
+    ```
+    
 All other steps work as before. If you want you can remove the googleapis include path in step 3 and 4 as the unannotated proto no longer requires them.