...

Text file src/github.com/grpc-ecosystem/grpc-gateway/docs/_docs/features.md

Documentation: github.com/grpc-ecosystem/grpc-gateway/docs/_docs

     1---
     2category: documentation
     3---
     4
     5# Features
     6
     7## Supported
     8* Generating JSON API handlers
     9* Method parameters in request body
    10* Method parameters in request path
    11* Method parameters in query string
    12* Enum fields in path parameter (including repeated enum fields).
    13* Mapping streaming APIs to newline-delimited JSON streams
    14* Mapping HTTP headers with `Grpc-Metadata-` prefix to gRPC metadata (prefixed with `grpcgateway-`)
    15* Optionally emitting API definition for [Swagger](http://swagger.io).
    16* Setting [gRPC timeouts](https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md) through inbound HTTP `Grpc-Timeout` header.
    17* Partial support for [gRPC API Configuration](https://cloud.google.com/endpoints/docs/grpc/grpc-service-config) files as an alternative to annotation.
    18
    19## Want to support
    20But not yet.
    21* Optionally generating the entrypoint. #8
    22* `import_path` parameter
    23
    24## No plan to support
    25But patch is welcome.
    26* Method parameters in HTTP headers
    27* Handling trailer metadata
    28* Encoding request/response body in XML
    29* True bi-directional streaming. (Probably impossible?)
    30

View as plain text