Proto Definitions
Raystack/Proton is an open-source project developed by Raystack (Open DataOps Foundation) that provides a unified way to define and manage APIs in a microservices architecture. It aims to simplify the development and deployment of APIs by abstracting away the underlying implementation details.
In Raystack/Proton, the Protobuf (protocol buffers) definitions are used to describe the structure and behavior of APIs. Protobuf is a language-agnostic binary serialization format developed by Google. It allows you to define the data models and API endpoints using a simple and concise syntax.
In the context of Frontier, the protobuf definitions are used to define the API endpoints and associated access control policies. These definitions specify the request and response message structures, allowed methods, and any additional metadata required for authorization checks.
By leveraging the protobuf definitions with Protobuf compilers like protoc and buf, Frontier automatically generates code for validating and enforcing the defined policies. It integrates with various frameworks and libraries to seamlessly enforce access control rules, ensuring that only authorized requests are allowed to access protected APIs and resources.
The current deployment uses the v1beta1 Frontier API version.
While making any changes in Frontier APIs, the makefile in Frontier contains the Proton commit hash, which is utilized in Frontier for generating protobuf files and documentation with make proto and make doc rules.
The make proto command creates apidocs.swagger.yaml specification which can be used to create a Postman collection to test these APIs.
Besides this, one can import these files it in the Swagger Editor to visualize the Frontier API documentation using the Swagger OpenAPI specification format.