add support for reflection

Author: ssddOnTop

README.md

@@ -13,7 +13,9 @@ This repository contains a gRPC-based Rust server implementing CRUD operations f
 ## Prerequisites
 
 Before you begin, ensure you have installed:
+
 - [Rust](https://www.rust-lang.org/tools/install)
+
 ## Installation
 
 ## Running the Server
@@ -63,10 +65,18 @@ message NewsList {
 }
 ```
 
+## Reflection api
+
+The server supports reflection api by default
+
+### example
+
+`grpcurl -plaintext localhost:50051 list`
+
 ## License
 
 This project is licensed under the MIT License.
 
-* * *
+---
 
 © 2024 @ Tailcall

build.rs

@@ -4,4 +4,11 @@ fn main() {
     let mut news = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
     news.push("news.proto");
     tonic_build::compile_protos(news).expect("Failed to compile protos");
+
+    let out_dir = PathBuf::from(std::env::var("OUT_DIR").unwrap());
+
+    tonic_build::configure()
+        .file_descriptor_set_path(out_dir.join("news_descriptor.bin"))
+        .compile(&["news.proto"], &["proto"])
+        .unwrap();
 }

src/main.rs

@@ -6,8 +6,11 @@ use news::news_service_server::NewsService;
 use news::{MultipleNewsId, News, NewsId, NewsList};
 use std::sync::{Arc, Mutex};
 use tower::make::Shared;
+
 pub mod news {
     tonic::include_proto!("news"); // The package name specified in your .proto
+    pub(crate) const FILE_DESCRIPTOR_SET: &[u8] =
+        tonic::include_file_descriptor_set!("news_descriptor");
 }
 
 #[derive(Debug, Default)]
@@ -149,11 +152,16 @@ async fn main() -> Result<()> {
     let addr = ([127, 0, 0, 1], 50051).into();
 
     let news_service = MyNewsService::new();
+    let service = tonic_reflection::server::Builder::configure()
+        .register_encoded_file_descriptor_set(news::FILE_DESCRIPTOR_SET)
+        .build()
+        .unwrap();
 
     println!("NewsService server listening on {}", addr);
 
     let tonic_service = TonicServer::builder()
         .add_service(NewsServiceServer::new(news_service))
+        .add_service(service)
         .into_service();
     let make_svc = Shared::new(tonic_service);
     println!("Server listening on http://{}", addr);