github.com/grpc-ecosystem/grpc-gateway/v2@v2.19.1/docs/index.md (about)

     1  ---
     2  layout: default
     3  title: gRPC-Gateway
     4  nav_order: 0
     5  description: "Documentation site for the gRPC-Gateway"
     6  permalink: /
     7  ---
     8  
     9  # gRPC-Gateway
    10  {: .fs-9 }
    11  
    12  gRPC-Gateway is a plugin of [protoc](https://github.com/protocolbuffers/protobuf). It reads a [gRPC](https://grpc.io/) service definition and generates a reverse-proxy server which translates a RESTful JSON API into gRPC. This server is generated according to [custom options](https://cloud.google.com/service-infrastructure/docs/service-management/reference/rpc/google.api#http) in your gRPC definition.
    13  {: .fs-6 .fw-300 }
    14  
    15  [Get started](#getting-started){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 } [View it on GitHub](https://github.com/grpc-ecosystem/grpc-gateway){: .btn .fs-5 .mb-4 .mb-md-0 }
    16  
    17  ---
    18  
    19  ## Getting started
    20  
    21  <a href="https://github.com/grpc-ecosystem/grpc-gateway/actions/workflows/main.yml"><img src="https://img.shields.io/github/workflow/status/grpc-ecosystem/grpc-gateway/main?color=379c9c&label=build&logo=github&logoColor=ffffff&style=flat-square"/></a>
    22  <a href="https://app.slack.com/client/T029RQSE6/CBATURP1D"><img src="https://img.shields.io/badge/slack-grpc--gateway-379c9c?logo=slack&logoColor=ffffff&style=flat-square"/></a>
    23  <a href="https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE"><img src="https://img.shields.io/github/license/grpc-ecosystem/grpc-gateway?color=379c9c&style=flat-square"/></a>
    24  <a href="https://github.com/grpc-ecosystem/grpc-gateway/releases"><img src="https://img.shields.io/github/v/release/grpc-ecosystem/grpc-gateway?color=379c9c&logoColor=ffffff&style=flat-square"/></a>
    25  <a href="https://github.com/grpc-ecosystem/grpc-gateway/stargazers"><img src="https://img.shields.io/github/stars/grpc-ecosystem/grpc-gateway?color=379c9c&style=flat-square"/></a>
    26  
    27  gRPC-Gateway helps you to provide your APIs in both gRPC and RESTful style at the same time.
    28  
    29  <div align="center">
    30  <img src="assets/images/architecture_introduction_diagram.svg" />
    31  </div>
    32  
    33  To learn more about gRPC-Gateway check out the documentation.
    34  
    35  ## Contribution
    36  
    37  See [CONTRIBUTING.md](https://github.com/grpc-ecosystem/grpc-gateway/blob/main/CONTRIBUTING.md).
    38  
    39  ## License
    40  
    41  gRPC-Gateway is licensed under the BSD 3-Clause License.
    42  
    43  See [LICENSE](https://github.com/grpc-ecosystem/grpc-gateway/blob/main/LICENSE) for more details.
    44  
    45  ### Thank you to the contributors of gRPC-Gateway
    46  
    47  <ul class="list-style-none">
    48  {% for contributor in site.github.contributors %}
    49  <li class="d-inline-block mr-1">
    50  <a href="{{ contributor.html_url }}"><img src="{{ contributor.avatar_url }}" width="32" height="32" alt="{{ contributor.login }}"/></a>
    51  </li>
    52  {% endfor %}
    53  </ul>