I suggest you ...

Allow API documentation with comments

This may be related to this:
https://servicestack.uservoice.com/forums/176786-feature-requests/suggestions/4459106-api-explorer-meta-data-enhancements

We have a lot of documentation to fill in, and while the Attributes are great for fine-grained details (if you need them), they are cumbersome with longer descriptions. It would be nice if I could just /// my classes / properties and ServiceStack would fill that in for the Notes (or maybe it's summary?). Maybe a swagger plugin option of ScanCommentsForNotes?

3 votes
Vote
Sign in
(thinking…)
Password icon
Signed in as (Sign out)
You have left! (?) (thinking…)
Josh Williams shared this idea  ·   ·  Flag idea as inappropriate…  ·  Admin →
declined  ·  AdminDemis J Bellot (Developer, ServiceStack) responded  · 

The libraries don’t have access to comments which aren’t embedded in the .dll. You can use the `[Description()]` or Description property in `[Api*]` attributes to emit comments in DTOs.

0 comments

Sign in
(thinking…)
Password icon
Signed in as (Sign out)
Submitting...

Feedback and Knowledge Base