Don't worry. Not everyone knows it...

Main focus of this article would be on how to make Web API more understandable to the consumers from Resource URI construction point. In Web API, each resource will have unique identifier. So, one should be very careful while constructing these URIs. Here are the few very good practices one should go for: URI should belong to NOUN rather than ACTIONS. URI example Is preferred? Remarks api/getemployees × api/employees √ Using GET api/id/employees × api/employees/{id} √ Fetch employee with a given ID using GET api/xyz/xyz/employees × api/employees √ api/employees/orderby/name × api/employees?orderby=name √ Filter criteria Should Nouns be Pluralize or not? It is up to you whether you want to go for pluralize nouns or not. But whatever decision you are making it should be consistent throughout the controller

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

In this article, we will create a Web API with in-memory database using Entity Framework and ASP.NET Core 2.0 without any theoretical explanation. To know more on concepts and theory, my previous articles can be referred. Let’s quickly create a new ASP.NET Core application by choosing API template and name it as ConferencePlanner. Add a new Model entity named Workshop inside a newly add Models folder as shown below: public class Workshop {     public int Id { get ; set ; }     public string Name { get ; set ; }     public string Speaker { get ; set ; } } Here we are going to use in-memory class along with EF. So, we have to add a new class for setting up the database context as shown below: public class ApplicationDbContext :DbContext {     public ApplicationDbContext(DbContextOptions<ApplicationDbContext> context): base (context)     {     } } Now we have to maintain multiple workshops under a conference. So, g