{"id":345,"date":"2020-05-19T13:23:45","date_gmt":"2020-05-19T13:23:45","guid":{"rendered":"https:\/\/startersites.io\/blocksy\/app\/?p=345"},"modified":"2025-01-09T13:40:32","modified_gmt":"2025-01-09T13:40:32","slug":"get-started-using-fintx-quickly","status":"publish","type":"post","link":"https:\/\/fintx.dev\/?p=345","title":{"rendered":"FintX Quickstart Guide"},"content":{"rendered":"\n

Before we start<\/h2>\n\n\n\n

Before getting started, make sure you have a running gRPC service. If the gRPC service does not have Reflection Service<\/em> enabled, make sure you have the proto <\/code>file that contains the service definition<\/p>\n\n\n\n

For this tutorial we’ll be using the sample Northwind gRPC service. The code for this service can be found on github at https:\/\/github.com\/namigop\/FintX\/tree\/main\/source\/Tefin.Grpc.Sample<\/a> . The proto file containing the service definitions is in the source\/Protos<\/code> sub folder. Below is a snippet of the proto file showing the service and its 6 methods<\/p>\n\n\n\n

<\/circle><\/circle><\/circle><\/g><\/svg><\/span><\/path><\/path><\/svg><\/span>
service<\/span> <\/span>NorthwindService<\/span> <\/span>{<\/span><\/span>\n  <\/span>\/\/ GetOrderById retrieves a single order by its ID<\/span><\/span>\n  <\/span>rpc<\/span> <\/span>GetOrderById<\/span>(<\/span>OrderRequest<\/span>) <\/span>returns<\/span> (<\/span>Order<\/span>) <\/span>{}<\/span><\/span>\n<\/span>\n  <\/span>\/\/ GetOrdersByCustomer streams all orders for a given customer<\/span><\/span>\n  <\/span>rpc<\/span> <\/span>GetOrdersByCustomer<\/span>(<\/span>CustomerRequest<\/span>) <\/span>returns<\/span> (<\/span>stream<\/span> <\/span>Order<\/span>) <\/span>{}<\/span><\/span>\n<\/span>\n  <\/span>\/\/ GetCustomers retrieves all customers<\/span><\/span>\n  <\/span>rpc<\/span> <\/span>GetCustomers<\/span>(<\/span>CustomersRequest<\/span>) <\/span>returns<\/span> (<\/span>CustomersResponse<\/span>) <\/span>{}<\/span><\/span>\n<\/span>\n  <\/span>\/\/ UpdateOrderStatus allows bidirectional streaming of order status updates<\/span><\/span>\n  <\/span>rpc<\/span> <\/span>UpdateOrderStatus<\/span>(<\/span>stream<\/span> <\/span>OrderStatusUpdate<\/span>) <\/span>returns<\/span> (<\/span>stream<\/span> <\/span>OrderStatusResponse<\/span>) <\/span>{}<\/span><\/span>\n<\/span>\n  <\/span>\/\/ AddOrderDetails allows streaming multiple order details for batch processing<\/span><\/span>\n  <\/span>rpc<\/span> <\/span>AddOrderDetails<\/span>(<\/span>stream<\/span> <\/span>OrderDetail<\/span>) <\/span>returns<\/span> (<\/span>OrderDetailsResponse<\/span>) <\/span>{}<\/span><\/span>\n<\/span>\n  <\/span>\/\/ SubmitOrder creates a new order with all its details<\/span><\/span>\n  <\/span>rpc<\/span> <\/span>SubmitOrder<\/span>(<\/span>SubmitOrderRequest<\/span>) <\/span>returns<\/span> (<\/span>SubmitOrderResponse<\/span>) <\/span>{}<\/span><\/span>\n}<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Let’s start<\/h2>\n\n\n\n
Take the gRPC Northwind Service and start it.  Once it’s up follow the steps below<\/p>\n\n\n\n
Create a gRPC client<\/h3>\n\n\n\n
Run FintX.exe and then click on the Add Client<\/code> button to bring up the dialog below. 
\"\"<\/p>\n\n\n\n
    \n
  1. Select Reflection Service (or proto file)<\/li>\n\n\n\n
  2. If you selected Reflection Server, enter the URL of the gRPC service<\/li>\n\n\n\n
  3. If the URL is hosting multiple gRPC services, select the one that you would like to test<\/li>\n\n\n\n
  4. Enter a name for this client<\/li>\n\n\n\n
  5. Optionally, add a description.<\/li>\n\n\n\n
  6. Now click the Okay <\/strong>button. FintX will generate code for the gRPC client and compile it. Once it’s completed, it will show the generated gRPC methods<\/li>\n<\/ol>\n\n\n\n
    Invoke a method<\/h3>\n\n\n\n
    Once, the client is compiled and displayed in the UI, you can double-click<\/code> on any method (or click the Open In New Tab<\/code> button, which shows up after selecting the method )<\/p>\n\n\n\n
    \"\"\n\t\t\t\n\t\t\t\t\n\t\t\t<\/svg>\n\t\t<\/button><\/figure>\n\n\n\n
      \n
    1. Select a method<\/li>\n\n\n\n
    2. Double click on any node in the object tree to edit its value<\/li>\n\n\n\n
    3. Invoke the gRPC service!<\/li>\n<\/ol>\n\n\n\n
      Summary<\/h2>\n\n\n\n
      Calling gRPC services with FintX is super easy.  Just add a client, open the method, edit the request, and finally click the Send button to invoke the service!<\/p>\n","protected":false},"excerpt":{"rendered":"
      Before we start Before getting started, make sure you have a running gRPC service. If the gRPC service does not have Reflection Service enabled, make sure you have the proto file that contains the service definition For this tutorial we’ll be using the sample Northwind gRPC service. The code for this service can be found […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"categories":[45],"tags":[],"class_list":["post-345","post","type-post","status-publish","format-standard","hentry","category-general"],"blocksy_meta":{"styles_descriptor":{"styles":{"desktop":"","tablet":"","mobile":""},"google_fonts":[]}},"_links":{"self":[{"href":"https:\/\/fintx.dev\/index.php?rest_route=\/wp\/v2\/posts\/345","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fintx.dev\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/fintx.dev\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/fintx.dev\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fintx.dev\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=345"}],"version-history":[{"count":5,"href":"https:\/\/fintx.dev\/index.php?rest_route=\/wp\/v2\/posts\/345\/revisions"}],"predecessor-version":[{"id":2518,"href":"https:\/\/fintx.dev\/index.php?rest_route=\/wp\/v2\/posts\/345\/revisions\/2518"}],"wp:attachment":[{"href":"https:\/\/fintx.dev\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=345"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fintx.dev\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=345"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fintx.dev\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=345"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}