A framework that provides extensions to create OpenAPI 3.0 specifications with NSwag.
NSwag toolchain used from https://github.com/RicoSuter/NSwag under the license https://github.com/RicoSuter/NSwag/blob/master/LICENSE.md.
Please only use this component if you agree to and comply with the above license terms.
To install Ibistic.Public.NSwag.Extensions, run the following command in the Package Manager Console
PM> Install-Package Ibistic.Public.NSwag.Extensions
Ibistic.Public.NSwag.Extensions currently only has a processor for including api version in the query string.
The api version processor from NSwag (NSwagProcessors.ApiVersionProcessor) only works when the versioning strategy used is based on the uri, i.e. /api/1.0/helloworld.
ApiVersionQueryStringProcessor has been built to support query string versioning, which is the default versioning mode in Web API 2, i.e. /api/helloworld?api-version=1.0.
The way to use it is just to specify the new processor when the Open API specification is created. There are several ways to create that specification, e.g using command line:
nswag webapi2openapi /operationprocessors:Ibistic.Public.NSwag.Extensions:Ibistic.Public.NSwag.Extensions.ApiVersionQueryStringProcessor /referencepaths:MyNugetAssemblyPath /assembly:MyWebAPI.dll /output:OpenApiDocument.OpenApi.json /outputtype:openapi3"
where MyNugetAssemblyPath is the folder where Ibistic.Public.NSwag.Extensions has been installed.
Remember to decorate your controllers and/or actions with the [ApiVersion] attribute and from highest to lowest version.
[ApiVersion("1.0")]
[RoutePrefix("api/helloworld")]
public sealed class HelloWorldController : ApiControllerThis is the result once the specificacion is created (used Redoc to render it).
This library is offered as is free for all under the MIT license: https://opensource.org/licenses/MIT
Copyright � Ibistic Technologies 2019