Comments (2)
hlgr360
commented on June 15, 2024
Looks like Google is thinking along the same lines: http://apievangelist.com/2017/03/10/api-definitions-covering-both-rest-and-grpc-apis/
having a REST API as public surface but leveraging protobug / gprot as internal API
from api-style-guide.
hlgr360
commented on June 15, 2024
https://cloud.google.com/apis/design/
This guide applies to both REST APIs and RPC APIs, with specific focus on gRPC APIs. gRPC APIs use Protocol Buffers to define their API surface and API Service Configuration to configure their API services, including HTTP mapping, logging, and monitoring. HTTP mapping features are used by Google APIs and gRPC Cloud Endpoints APIs for JSON/HTTP to Protocol Buffers/RPC transcoding.
from api-style-guide.
Related Issues (20)
- Add link to swagger blog entry to api style guide
- Obtain permission from James Higginbotham for summarizing design process HOT 1
- Reemphasize design guidance on API first and Code second HOT 1
- Add chapter on Webhooks HOT 1
- Add chapter on client-controlled resource representation
- Sharpen argument for hypermedia and add list of client libs/projects HOT 1
- Sketch out hypermedia interaction pattern (incl caching and service document) HOT 5
- Add Fielding Property Maps
- Add discussion of idempotency
- Add best practices from QT API guide
- Add hiding of internal codes
- Explicitly ban snake-syntax
- Define API Discovery Format HOT 7
- Re-evaluate (in 11/2017) error response formats
- Add batch API (design) guidance
- Clarify use of GraphQL for mobile app interfaces only when using React/Redux
- add section on the need for api evangelism
- Clarifying use of schema for documentation, not code generation
- Drop the requirement of the API review? HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from api-style-guide.