Generating version specific help documentation pages for ASP.NET Web API application

Question

I am using the WebAPI Versioning package to version my API by the X-Api-Header by using the "VersionHeaderVersionedControllerSelector". I am also using the Microsoft.AspNet.WebApi.HelpPage to autogenerate documentation for the APIs. In order for controller versionign to work, they need to be namespaced with the VersionXYZ as the suffix in the namespace so that the "VersionHeaderVersionedControllerSelector" is able to route the request to the appropriate version of the controller like so:

namespace WEBAPI.Api.Controllers.Version1
{ public class ProductsController : ApiController {} }

namespace WEBAPI.Api.Controllers.Version2
{ public class ProductsController : ApiController {} }

This works as intended but when I look at the generated help pages the ApiDescription is including the "VersionXYZ" suffix from the namespace in the ID (GETapi/Version1.Products) and RelativePath(api/Version1.Products) properties. Ideally what I'd like to do is to have a top level help page which just the API Version numbers and drilling in would show the API the normal way i.e. The ApiDescription.ID = GETapi/Products and the ApiDescription.RelativePath = api/Products

Is there a way to achieve this using the Out of the Box APIs or am I going to need to rollout my own implementation of ApiExplorer

Did you ever find a solution to this problem?

TheQ
– TheQ

2014-02-19 15:42:18 +00:00
Commented Feb 19, 2014 at 15:42 — TheQ
– TheQ, Commented Feb 19, 2014 at 15:42
Is it asp.net web api 2.0?

Felipe Oriani
– Felipe Oriani

2014-07-15 13:34:19 +00:00
Commented Jul 15, 2014 at 13:34 — Felipe Oriani
– Felipe Oriani, Commented Jul 15, 2014 at 13:34

Community · Accepted Answer · 2017-05-23 12:15:48Z

1

Check out this answer Get Help page works with Api Versioning

Make sure you have configure the versioning right, and you need to get a documentation XML file from your project XXXX.Api.v1 project and place it in the bin folder of the XXXX.Api project.

edited May 23, 2017 at 12:15

CommunityBot

11 silver badge

answered Nov 23, 2014 at 13:23

Philip Ding

1,6012 gold badges12 silver badges11 bronze badges

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

Comments

Yishai Galatzer · Accepted Answer · 2014-10-08 15:26:53Z

0

Unfortunately ApiExplorer does not support duplicate controller names. So by implementing controller versioning this way, your (or the package code) doesn't play nicely with the system.

Consider another alternative where you actually change the controller name (and yes you will have to implement your own solution, but honestly its not that complex). For example make the version be part of the controller name itself (rather than its name space).

e.g. Ver1_ProcuctsController

Now these will start showing up on your help page, and since help page is just content package you can change the logic to make the names that start with verxxx_ to mutate.

answered Oct 8, 2014 at 15:26

Yishai Galatzer

8,8622 gold badges35 silver badges42 bronze badges

Collectives™ on Stack Overflow

Generating version specific help documentation pages for ASP.NET Web API application

2 Answers 2

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related