wechaty-openapi

Wechaty Puppet OpenAPI Specification (OAS)

Image credit: Introducing gRPC HTTP API

Motivation

We have gRPC for Wechaty Puppet, and we want a RESTful API as well, so we built OpenAPI Specification (OAS, former Swagger) on top of gRPC, with the power of gRPC OAS Gateway.

Known Issues

• Upload file via auto-generated OpenAPI specification with gRPC backend #1

gRPC Transcoding

• Google Cloud: Transcoding HTTP/JSON to gRPC
• Envoy: gRPC-JSON transcoder

RESTful API Naming Convention

• REST Resource Naming Guide
• 10+ Best Practices for Naming API Endpoints
• PUT vs. POST in REST
• Google Cloud Common Design Patterns

Tutorials

• Talk video: Writing REST Services for the gRPC curious, Johan Brandhorst, 2019, GopherCon UK
• Take a REST with HTTP/2, Protobufs, and Swagger
• All the boilerplate you need to get started with writing grpc-gateway powered REST services in Go

Resources

• OpenAPI Specification v3.1
• gRPC with REST and Open APIs

History

master

v0.0.1 (Feb 22, 2021)

TODO

Author

Huan LI (李卓桓), Microsoft Regional Director, <[e-mail]>

Copyright & License

• Code & Docs © 2021-now Huan LI <[e-mail]>
• Code released under the Apache-2.0 License
• Docs released under Creative Commons