https://github.com/sudorandom/fauxrpc

Easily start a fake gRPC/gRPC-Web/Connect/REST server from protobufs
https://github.com/sudorandom/fauxrpc

api connectrpc grpc grpc-web rest-api

Last synced: 6 days ago
JSON representation

Easily start a fake gRPC/gRPC-Web/Connect/REST server from protobufs

• Host: GitHub
• URL: https://github.com/sudorandom/fauxrpc
• Owner: sudorandom
• License: mit
• Created: 2024-08-15T17:24:23.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-12-07T20:27:21.000Z (16 days ago)
• Last Synced: 2024-12-08T05:42:55.187Z (16 days ago)
• Topics: api, connectrpc, grpc, grpc-web, rest-api
• Language: Go
• Homepage: https://fauxrpc.com
• Size: 1.99 MB
• Stars: 82
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![]()

# FauxRPC

[![Go](https://github.com/sudorandom/fauxrpc/actions/workflows/go.yml/badge.svg)](https://github.com/sudorandom/fauxrpc/actions/workflows/go.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/sudorandom/fauxrpc)](https://goreportcard.com/report/github.com/sudorandom/fauxrpc) [![Go Reference](https://pkg.go.dev/badge/github.com/sudorandom/fauxrpc.svg)](https://pkg.go.dev/github.com/sudorandom/fauxrpc)

[FauxRPC](https://fauxrpc.com) is a powerful tool that empowers you to accelerate development and testing by effortlessly generating fake implementations of gRPC, gRPC-Web, Connect, and REST services. If you have a protobuf-based workflow, this tool could help.

## Why FauxRPC?

* **Faster Development & Testing:** Work independently without relying on fully functional backend services.

* **Isolation & Control:** Test frontend components in isolation with controlled fake data.

* **Multi-Protocol Support:** Supports multiple protocols (gRPC, gRPC-Web, Connect, and REST).

* **Prototyping & Demos:** Create prototypes and demos quickly without building the full backend. Fake it till you make it.

* **API Stubs:** Define static or dynamic API responses with powerful stubs featuring [CEL expressions](https://cel.dev/) for precise behavior control. Stubs can be defined using config files or dynamically at runtime.

* **Improved Collaboration:** Bridge the gap between frontend and backend teams.

* **Plays well with others:** Test data from FauxRPC will try to automatically follow any [protovalidate](https://github.com/bufbuild/protovalidate) constraints that are defined.

* **Request Validation:** Ensure data integrity with automatic request validation using [protovalidate](https://github.com/bufbuild/protovalidate). Catch errors early and prevent invalid data from reaching your application logic.

See the [the documentation website](https://fauxrpc.com) for more!

## Get Started

### Install via source

```

go install github.com/sudorandom/fauxrpc/cmd/fauxrpc@latest

```

### Pre-built binaries

Binaries are built for several platforms for each release. See the latest ones on [the releases page](https://github.com/sudorandom/fauxrpc/releases/latest).

## Quick Start

Pass [protobuf descriptors](https://buf.build/docs/reference/descriptors) to FauxRPC and a test server will be created, returning random fake data!

```shell

$ fauxrpc run --schema=service.binpb

```

That's... it. Now you can call it with your gRPC/gRPC-Web/Connect clients:

```shell

$ buf curl --http2-prior-knowledge http://127.0.0.1:6660/my.own.v1.service/HelloWorld

{

  "text": "Thundercats."

}

```

Go to [the documentation website](https://fauxrpc.com) for more!