Dokumentacja web-api & swagger

Question

Napisałem stronę WWW ASP-API i dodałem wersję do api używając this class.

Moje trasy wyglądać następująco:

config.Routes.MapHttpRoute(
    name: "DefaultApi", 
    routeTemplate: "{namespace}/{controller}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
); 

config.Services.Replace(typeof(IHttpControllerSelector), new NamespaceHttpControllerSelector(config)); 

Więc mam dostępu https://localhost:44301/v1/test

Jestem teraz próbuje dodać Swagger produkować jakąś dokumentację API (faktycznie używam pakiet Swashbuckle Nuget)

Kiedy przeglądać /swagger obciążenia wymienione strony, ale wyjdzie z błędami dla wszystkich kontrolerów:

Unable to read api 'TestController' from path https://localhost:44301/swagger/api-docs/TestController (server returned undefined) 

Gdybym przeglądać https://localhost:44301/swagger/api-docs/TestController to wyjdzie z NullReferenceException ze śladu stosu:

at Swashbuckle.Swagger.OperationGenerator.CreateParameter(ApiParameterDescription apiParamDesc, String apiPath) 
    at Swashbuckle.Swagger.OperationGenerator.<>c__DisplayClass2.<ApiDescriptionToOperation>b__1(ApiParameterDescription paramDesc) 
    at System.Linq.Enumerable.WhereSelectEnumerableIterator`2.MoveNext() 
    at System.Collections.Generic.List`1..ctor(IEnumerable`1 collection) 
    at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source) 
    at Swashbuckle.Swagger.OperationGenerator.ApiDescriptionToOperation(ApiDescription apiDescription) 
    at System.Linq.Enumerable.WhereSelectEnumerableIterator`2.MoveNext() 
    at System.Linq.Buffer`1..ctor(IEnumerable`1 source) 
    at System.Linq.OrderedEnumerable`1.<GetEnumerator>d__0.MoveNext() 
    at System.Collections.Generic.List`1..ctor(IEnumerable`1 collection) 
    at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source) 
    at Swashbuckle.Swagger.ApiExplorerAdapter.CreateApi(IGrouping`2 apiDescriptionGroup, OperationGenerator operationGenerator) 
    at Swashbuckle.Swagger.ApiExplorerAdapter.<>c__DisplayClassb.<GetDeclaration>b__7(IGrouping`2 apiDescGrp) 
    at System.Linq.Enumerable.WhereSelectEnumerableIterator`2.MoveNext() 
    at System.Linq.Buffer`1..ctor(IEnumerable`1 source) 
    at System.Linq.OrderedEnumerable`1.<GetEnumerator>d__0.MoveNext() 
    at System.Collections.Generic.List`1..ctor(IEnumerable`1 collection) 
    at System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source) 
    at Swashbuckle.Swagger.ApiExplorerAdapter.GetDeclaration(String basePath, String version, String resourceName) 
    at Swashbuckle.Application.CachingSwaggerProvider.<>c__DisplayClass4.<GetDeclaration>b__3(String k) 
    at System.Collections.Concurrent.ConcurrentDictionary`2.GetOrAdd(TKey key, Func`2 valueFactory) 
    at Swashbuckle.Application.CachingSwaggerProvider.GetDeclaration(String basePath, String version, String resourceName) 
    at Swashbuckle.Application.SwaggerSpecHandler.SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) 
    at System.Net.Http.HttpMessageInvoker.SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) 
    at System.Web.Http.Dispatcher.HttpRoutingDispatcher.SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) 
    at System.Net.Http.DelegatingHandler.SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) 
    at System.Web.Http.HttpServer.<>n__FabricatedMethod9(HttpRequestMessage , CancellationToken) 
    at System.Web.Http.HttpServer.<SendAsync>d__0.MoveNext() 

Gdybym zmienić trasę tak:

config.Routes.MapHttpRoute(
    name: "DefaultApi", 
    routeTemplate: "{controller}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
) 

Strony Swagger następnie pracować, ale rzeczywiste API nie działa!

Pytanie brzmi, jak mogę sprawić, aby Swagger działał z wersjonowanym API?

Answer 1

w końcu kiedyś SDammann.WebApi.Versioning pakiet Nuget i następujących trasach:

VersionedControllerSelector.VersionPrefix = "v"; 

config.Routes.MapHttpRoute(
    name: "DefaultApi", 
    routeTemplate: "v{version}/{controller}/{id}", 
    defaults: new { id = RouteParameter.Optional } 
); 

Moi kontrolerzy są w przestrzeni nazw o nazwie V1 lub V2 itp

Answer 2

spróbować tej

config.Routes.MapHttpRoute(
      name: "DefaultApi", 
      routeTemplate: "api/{controller}/{action}" 
      //defaults: new { id = RouteParameter.Optional } 
     );