The ReProto project is a language-neutral protocol specification, aimed towards describing and generating code for handling messages exchanged through JSON-based APIs.
ReProto specifies a DSL that described JSON types and services. Using this, models can be generated using multiple different target languages.
.reproto files is.Note: This project is in an Alpha-stage. Things will change a lot.
java)
-m fasterxml), and/or
lombok (-m lombok).js)
python)
rust)
doc)
Make you have gotten started with Rust.
Build ReProto using cargo:
bash
$> cargo build
This will install the command into ~/.cargo/bin, make sure it is in your $PATH.
Build documentation:
bash
$> target/debug/reproto compile doc -o target/doc --path it/test-service/proto \
--package test \
--package service@1.0.0 \
--package service@2.0.0
$> open target/doc/index.html
For more example, please have a look at our integration tests.
A Maven plugin that integrates reproto into the build lifecycle of a maven project.
A VIM plugin that provides syntax highlighting.
This project includes an extensive set of integration tests.
See make help for documentation on what can be done.
Suites are tests which compiled a given set of rules, and compares with expected output.
Projects are complete project tests. These are projects written for various programming languages, and are generally harder to build.
The tool check-project-deps is used to determine
which projects your local system can build.
To run all tests, do:
bash
$> make clean all
ReProto uses a DSL for specifying schemas that is not based on an existing general purpose markup like JSON.
The goal is to have a compact, intuitive, and productive language for writing specifications.
The following is a simple petstore example using ReProto.
``` /// # ReProto Petstore /// /// A sample API that uses a petstore as an example to demonstrate features in the ReProto /// specification service Petstore { "api" { /// Returns all pets from the system that the user has access to. GET "pets" { /// A list of pets. returns 200 "application/json" [Pet]; } } }
type Pet { id: unsigned/64; name: string; tag?: string; } ```
You can compile the above into documentation using the following command:
bash
$> reproto compile doc --out petstore-doc --path examples/petstore --package petstore@1.0.0
As a comparison the following is a specification using OpenAPI 2.0.
json
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Swagger Petstore",
"description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"name": "Swagger API Team"
},
"license": {
"name": "MIT"
}
},
"host": "petstore.swagger.io",
"basePath": "/api",
"schemes": [
"http"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/pets": {
"get": {
"description": "Returns all pets from the system that the user has access to",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "A list of pets.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Pet"
}
}
}
}
}
}
},
"definitions": {
"Pet": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"tag": {
"type": "string"
}
}
}
}
}
If you miss JSON, you can compile the specification to JSON as well.
bash
$> reproto compile json --out petstore-json --path examples/petstore --package petstore@1.0.0