https://github.com/universe-proton/protoc-gen-swagger
A python package for swagger annotation proto files.
https://github.com/universe-proton/protoc-gen-swagger
grpc grpc-gateway protobuf3 python3 swagger
Last synced: 5 months ago
JSON representation
A python package for swagger annotation proto files.
- Host: GitHub
- URL: https://github.com/universe-proton/protoc-gen-swagger
- Owner: universe-proton
- License: apache-2.0
- Created: 2018-01-29T08:14:27.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-30T02:47:34.000Z (about 8 years ago)
- Last Synced: 2025-10-21T05:55:43.124Z (5 months ago)
- Topics: grpc, grpc-gateway, protobuf3, python3, swagger
- Language: Python
- Size: 15.6 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
protoc-gen-swagger
====================
.. image:: https://travis-ci.org/universe-proton/protoc-gen-swagger.svg?branch=master
:target: https://travis-ci.org/universe-proton/protoc-gen-swagger
A python package for swagger's annotation protobuf files, which are located inside `grpc-gateway `_ repository.
`Swagger `_ is a popular api tool. When you import swagger proto files in your protobuf message file, you may get stuck when using the generated python code.
An import error as the following:
.. code-block::
ModuleNotFoundError: No module named 'protoc_gen_swagger'
With this package, you could forget the error.
Installation
============
We can simply use pip to install, as the following:
.. code-block:: bash
$ pip install protoc-gen-swagger
or installing from git
.. code-block:: bash
$ pip install git+https://github.com/universe-proton/protoc-gen-swagger
Maintain
=========
When the source repository `grpc-gateway `_ is taged, we can use command `bash gen.sh ` to update the package.
Maybe we could do some automated work in the future.
Now, this package version 0.1.0 is the same as grpc-gateway version v1.3.1 .
How to Contribute
=================
Open an `issue `_, join a discussion or make a pull request.