No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
01-ajiting.proto
01-ajiting.swagger.json
02-ajiting.proto
02-ajiting.swagger.json
LICENSE
Makefile
README.md

README.md

protobuf-swagger-example

Requirements

  • Make
  • Protocol Buffers
  • Swagger
  • grpc-gateway v1.5.0+

Directory Structure

  • 01-ajiting.proto: A simple example Protocol Buffers file of #ajiting Web API definition
  • 01-ajiting.swagger.json: Generated from 01-ajiting.proto (see also the following chapter)
  • 02-ajiting.proto: A complex (with OpenAPI specific configurations) example Protocol Buffers file of #ajiting Web API definition
  • 02-ajiting.swagger.json: Generated from 02-ajiting.proto (see also the following chapter)

How To Use

  1. Make sure that the above Requirements are satisfied on your environment.
  2. Run $ make 01-ajiting.swagger.json or $ make 02-ajiting.swagger.json
  • If you want to know about what these commands' doing, type $ cat Makefile
  1. Enjoy!