search

gigya / microdot

Microdot: An open source .NET microservices framework
Apache License 2.0
1.54k stars 230 forks source link

Lack of Documentation #275

Open zeinali0 opened 4 years ago

zeinali0 commented 4 years ago

Is there any complete Documentation to cover all features provided by framework?

daniellm commented 4 years ago

Unfortunately not. If you have specific questions, I might be able to provide quick answers.

zeinali0 commented 4 years ago

We are creating an instant messaging app with microservice architecture and i'm just searching for tools to help us. But i couldn't find any usefull documents for microdot. We would have an API Getway but Our client will not use http, instead they use some Protocol which name MTProto. It based on TCP or Websocket. I don't know how much microdot can help us as we cannot use some feature like Service Discovery, Health Checker and others which they designed for http protocol

daniellm commented 4 years ago

Note that typically your micro-services are deployed in some data center and communicate with one another directly. Your API gateway will typically accept incoming requests from the outside world and route them to the relevant micro-service. The protocol the API gateway supports (e.g. MTProto) is unrelated to the internal protocol between microservices (e.g. HTTP for Microdot).

zeinali0 commented 4 years ago

Thanks for the Note. So Does any work started for Documentation yet? Because there is no sample for many features which it provide and i have no idea how should i use this framework.

daniellm commented 4 years ago

Unfortunately not. We may put more focus on this in 2020, but probably only in the second half. I'm sorry. You're welcome to fly over here and we'll give you the rundown :)