Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

WebAPI help page for complex type in URI

I'm using WebAPI help page to provide a documentation. Documentation is generated fine (from xml comments) except when I use complex model in the uri. So, I get the following doc

GET service/Tst2    No documentation available.

for the method:

    /// <summary>
    /// description
    /// </summary>
    [HttpGet]
    public string Tst([FromUri] TstModel filter)
    {
        return null;
    }

    public class TstModel
    {
        public int Id { get; set; }
    }

for other methods with simple int/string parameters it works as expected. If I remove [FromUri] attribute it also works, but then

So the question is: how can I show documentation for such methods? How can I provide documentation for complex types taken from the URI?

like image 227
Shaddix Avatar asked Dec 01 '25 12:12

Shaddix


1 Answers

Regarding your original question about help not being generated for Complex Type decorated with [FromUri] attribute, its a known issue on which we would be working on.

like image 134
Kiran Avatar answered Dec 04 '25 17:12

Kiran