Generating documentation for MediatR requests #420
Unanswered
Chris-Mingay
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi all,
I am looking to create API documentation for the application layer, specifically the MediatR commands and queries. I would like to keep the documentation within triple slash comments associated with each Command/Query class and ideally I would like to be able to use markdown. I would like to be able to run something to generate a static HTML site for the documentation, ideally at build time.
I would also like to describe the DTO objects that a MediatR query can return.
Has anyone else implemented similar? Any recommendations?
I've been messing around with docfx but I am not sure it really fits well with MediatR IRequest classes, that or I am not getting my head around how to use it properly!
Thanks
Beta Was this translation helpful? Give feedback.
All reactions