Chameleon Articles Directory

Instant database Web API

Jan
31

Create ASP.Net Web API from MS SQL in seconds with Instant Web API? A well designed API is self-documenting. If you know how to work with one REST API, you will quickly learn the quirks of others. InstantWebApi is an API-first product. I spent a lot of time on API design. My intent is to be able to hire multiple teams in parallel, giving them access to my API, and seeing which implementation I like best. They will all be compatible. I can then simply discontinue the less interesting implementation projects.

Benefits of REST Over SOAP. In addition to using HTTP for simplicity, REST offers a number of other benefits over SOAP: REST allows a greater variety of data formats, whereas SOAP only allows XML. Coupled with JSON (which typically works better with data and offers faster parsing), REST is generally considered easier to work with.

Hide Internal Codes: Needless to say, this is an implementation detail that gives away that we are using a relational database, and experienced Oracle users would instantly spot that it’s Oracle’s sample HR schema. This leaking makes it harder to switch to a document-oriented database, like MongoDB, where there is no concept of foreign keys. But even if the chance of switching to MongoDB is zero, it still makes the response harder to read. So a better approach is to let the REST API translate the internal code to the human-readable value that the code represents (i.e. “Shipping Clerk”) and then also remove the Id part of the field name. This version is definitely more readable, but a fair concern is if the service will be slower now that it needs to lookup the value? I used to be an avid reader of Tom Kyte, the Oracle DB expert, and still remember that you should always optimize from measurements. I mean there’s a good chance that the HTTP cache will help us out and make it less of a bottleneck than it appears at first glance. As a rule of thumb, if performance means everything to you (or you have a lot of lookup fields) then you might consider leaking the internal codes. Otherwise, you should provide a more readable API by hiding them.

Code will be generated into the initial stub Visual Studio solution. At this point the solution can be build and is ready to use. The solution should contain 2 projects; one for the actual Web API and another one for Unit Tests. Using the Unit Test project you can test the quality of the Web API that was generated. The Web API project should contain a referrence to Swagger UI, that allows for clear documentation and testing of the newly created API. Build an instant database Web API now, no coding required. Generate your Web API in minutes to build applications faster. Using Entity Framework 6.2.0 and VS 2017 generate your Web API for any MS SQL database. NEW – Use Core EF to build Instant Web API! Using Core Entity Framework 2.2 and VS 2019 generate your Web API for any MS SQL database. Read more info at http://instantwebapi.com/.

Computers Comments Off on Instant database Web API

Comments

Comments are closed.