Hi Chanan,
I am not aware of tools of the like of Swagger for plain actor messaging.
What we see people do and also encourage is to keep Actor messages in their
companion objects.
For example like so:
object RegistrationActor {
case class Register(…)
object Registration {
trait Failure
case class UserAlreadyExists(…) extends Failure
// … more things here …
}
class RegistrationActor extends Actor { … }
Hope this helps!
--
Cheers,
Konrad 'ktoso’ Malawski
Akka @ Typesafe
On 21 May 2015 at 20:04:10, Chanan Braunstein ([email protected])
wrote:
Hello,
More and more teams are adopting Akka at my company and now that we need to
work with Actors written by others (and since Roland's Typed actors isn't ready
yet :) ), we find that we need to document the actors and the messages that are
available to them. When we do REST, we use Swagger for this. Has anyone come
accross a useful tool to generate message documentation or does everyone just
use ScalaDoc/JavaDoc?
Chanan
--
>>>>>>>>>> Read the docs: http://akka.io/docs/
>>>>>>>>>> Check the FAQ:
>>>>>>>>>> http://doc.akka.io/docs/akka/current/additional/faq.html
>>>>>>>>>> Search the archives: https://groups.google.com/group/akka-user
---
You received this message because you are subscribed to the Google Groups "Akka
User List" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.
--
>>>>>>>>>> Read the docs: http://akka.io/docs/
>>>>>>>>>> Check the FAQ:
>>>>>>>>>> http://doc.akka.io/docs/akka/current/additional/faq.html
>>>>>>>>>> Search the archives: https://groups.google.com/group/akka-user
---
You received this message because you are subscribed to the Google Groups "Akka
User List" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.