wechaty-openapi
v0.1.0
Published
Wechaty Puppet RESTful API Service
Downloads
3
Maintainers
Readme
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
gRPC Transcoding
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
History
master
v0.0.1 (Feb 22, 2021)
TODO
Author
Huan LI (李卓桓), Microsoft Regional Director, <[email protected]>
Copyright & License
- Code & Docs © 2021-now Huan LI <[email protected]>
- Code released under the Apache-2.0 License
- Docs released under Creative Commons