Skip to main content


Showing posts with the label Web API 2.0

Generating documentation for Web API 2.0

In my previous article, we got the gist of Web API but we didn’t do anything on documentation part. So, in this article we will cover the documentation of our Wep API which will help the users using Swagger. What is Swagger? Swagger is a standard which is used to define the API, so that endpoints can be found and discovered easily with the help of small documentation along with the user interface. If it is clear that what API is doing, one can easily consume these APIs. It is similar to WSDL for Web Services. How to get Swagger? Swagger is an open source library with a name SwashBuckle and can be taken by any means of importing packages. Let’s have a look on how to get it from Nuget: What code changes are required? First of all, we have to go and register the service for swagger as: public void ConfigureServices(IServiceCollection services) { services.AddMvc(); services.AddSwaggerGen(options=> { options.SwaggerDoc( "Version 1" , new Sw