https://github.com/roadrunner-php/roadrunner-api-dto

RoadRunner proto files and generated DTO files
https://github.com/roadrunner-php/roadrunner-api-dto

php proto protobuf roadrunner

Last synced: about 2 hours ago
JSON representation

RoadRunner proto files and generated DTO files

• Host: GitHub
• URL: https://github.com/roadrunner-php/roadrunner-api-dto
• Owner: roadrunner-php
• License: mit
• Created: 2023-03-17T08:36:11.000Z (over 2 years ago)
• Default Branch: 1.x
• Last Pushed: 2025-08-12T14:05:25.000Z (about 2 months ago)
• Last Synced: 2025-09-15T11:22:09.917Z (24 days ago)
• Topics: php, proto, protobuf, roadrunner
• Language: PHP
• Homepage: https://roadrunner.dev
• Size: 1.37 MB
• Stars: 8
• Watchers: 5
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


  

    

    

  



# RoadRunner PHP API DTO

[![PHP Version Require](https://poser.pugx.org/roadrunner-php/roadrunner-api-dto/require/php)](https://packagist.org/packages/roadrunner-php/roadrunner-api-dto)

[![Latest Stable Version](https://poser.pugx.org/roadrunner-php/roadrunner-api-dto/v/stable)](https://packagist.org/packages/roadrunner-php/roadrunner-api-dto)

[![Total Downloads](https://poser.pugx.org/roadrunner-php/roadrunner-api-dto/downloads)](https://packagist.org/packages/roadrunner-php/roadrunner-api-dto)

This is a GitHub repository and Composer package that provides PHP Data Transfer Object (DTO) messages for RoadRunner

API protocol buffer files, available at https://github.com/roadrunner-server/api.

With this repository, you can use pre-generated DTO messages for the following RoadRunner plugins:

- Centrifugo

- HTTP

- Jobs

- KV

- Lock

- Plugins

- Service

- Status

- WebSockets

The repository contains the pre-generated DTO files, and you can include the package in your PHP project to use them for

making RPC calls to the RoadRunner server.

## Installation

You can install the package. Simply run the following command:

```bash

composer require roadrunner-php/roadrunner-api-dto

```

## Generating DTOs

If you would like to generate the DTOs yourself, you can use the `generate.sh` script. This script will generate the

DTOs for all of the plugins, and place them in the `generated/` directory.

But before that, you will need to compile the `grpc_php_plugin`. Follow [this instruction](https://github.com/grpc/grpc/blob/master/src/php/README.md#grpc_php_plugin-protoc-plugin) to build the file.

Then run:

```bash

./generate.sh

```

> Note: You will need to have the `protoc` >= 3.15 binary installed on your system.

## Contribution

Contributions are welcome! If you would like to contribute to this project, please open an issue or pull request.

## License

This repository is licensed under the MIT license. See [LICENSE](./LICENSE) for more information.