WebApi2 Help Page stops generating documentation after extending ApiController

Question

I have extended ApiController to include some common properties/methods, and this extended controller is held in a separate class library/assembly.

public class ExtendedApiController : ApiController
{
    // shared properties...
}

In my Api project, all controllers inherit from this extended controller.

public class HomeApiController : ExtendedApiController
{
    // actions...
}

Pretty simple...

However, extending the base class now prevents the Help Page generator from actually generating documentation from these controllers. If I switch the controllers back to inheriting directly from ApiController they are visible in the docs.

Is there a way to allow/change the assembly name the generator looks for? I have a sneaking suspicion that it is comparing a base class directly to "ApiController" and is therefore skipping all of mine.

I think there is something else going on, maybe something in the extended controller that the documentation generator doesn't get, because I use an extended controller like that in my web api without a problem with the generated documentation. — Stephen
– Stephen, Commented Jan 24, 2014 at 17:44

nak5ive · Accepted Answer · 2014-01-24 19:56:10Z

1

Well, as it turns out the fact that my base class was in a different assembly was part of the problem. The real issue was the fact that these projects referenced different versions of the WebApi2 libraries. Unfortunately, the conflicting package version was only listed as a warning, not an error, so I missed it. An update of all NuGet packages across all projects in the solution fixed the issue.

answered Jan 24, 2014 at 19:56

nak5ive

1,9734 gold badges16 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Stephen Over a year ago

Compile with 'warnings as errors', so you don't overlook them next time. There's a reason you are warned ;)

Collectives™ on Stack Overflow

WebApi2 Help Page stops generating documentation after extending ApiController

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related