Shulou(Shulou.com)06/02 Report--

Web API interface design experience, I believe that many inexperienced people do not know what to do, so this paper summarizes the causes of the problem and solutions, through this article I hope you can solve this problem.

In the Web API interface development process, we may encounter a variety of problems, after a large number of module practice and successful operation, summed up this essay, I hope to help you.

1. Determine the GET or POST mode of MVC in the API definition.

Since our entire Web API platform is developed on the basis of MVC, the entire Web API interface generally needs to be displayed to declare whether the interface is [HttpGet] or [HttpPost]. Although some interfaces do not need to be declared, it is good to avoid error messages similar to the following.

For example, the lookup object interface defined in the base class is as follows.

/ query the database, check whether there is an ID value of the specified ID object / object / and return the specified object, otherwise return Null [HttpGet] public virtual T FindByID (string id, string token)

If it is an added, deleted or modified interface, you generally need to declare that the data is submitted in POST mode, and for security reasons, you need to carry more parameters.

/ / insert the specified object into the database / whether the operation was successful or not. [HttpPost] public virtual CommonResult Insert (T info, string token, string signature, string timestamp, string nonce, string appid) 2. Interface definition of dynamic objects

In a general Web API interface, we may encounter many simple types of parameters, but we want them to submit data in POST, so we can deal with them in two ways, one is to define a class to place these parameters, and the other is to use dynamic JObject parameters. The former has a lot of inconvenience, because it is impossible to define one more entity class for each interface parameter. There may be a lot of class definitions that are difficult to manage. For example, the following is an example of the calling API of Wechat API. We also need to set such processing rules.

API call request description http request method: POST (please use https protocol) https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN POST data format: json POST data example: {"group": {"id": 108, "name": "test2_modify2"}}

So what is it like when we use JObject? let's look at the definition of the interface and the handling code. JObject is an object under the Newtonsoft.Json.Linq namespace.

/ / modify user password / compound object containing userName and userPassword / user access token / [HttpPost] public CommonResult ModifyPassword (JObject param, string token) {/ / token check If it fails, an exception CheckResult checkResult = CheckToken (token) is thrown. Dynamic obj = param; if (obj! = null) {string userName = obj.userName; string userPassword = obj.userPassword; bool success = BLLFactory.Instance.ModifyPassword (userName, userPassword); return new CommonResult (success) } else {throw new MyApiException ("error occurred in passing parameters");}}

When we convert the JObject object to the object we need, because we do not define a specific entity class, we use dynamic syntax to declare that this is a dynamic object, and the corresponding properties are obtained by the runtime.

Dynamic obj = param

In this way, when we call, the JSON object corresponding to the dynamic POST is given to the Web API interface without the need to pre-define classes with various interface parameters.

/ / call the Web API API to change the user password / user name / modified password / if the modification is successful, return true, otherwise return false public bool ModifyPassword (string userName, string userPassword) {var action = "ModifyPassword". Var postData = new {userName = userName, userPassword = userPassword} .ToJson (); string url = GetTokenUrl (action); CommonResult result = JsonHelper.ConvertJson (url, postData); return (result! = null)? Result.Success: false;}

GetTokenUrl constructs a complete submission address based on parameters such as the address of token and API. We passed the code above.

Var postData = new {userName = userName, userPassword = userPassword} .ToJson ()

You can dynamically create an object, generate its JSON string, submit the data POST to the corresponding API interface, and then convert the result to the object.

3. Collection and paging processing

In many interfaces, we need to use paging processing, and Web API is no exception, which can submit data retrieval efficiency, reduce the pressure of server data processing, and also submit the data display speed of the client.

The general collection interface definition is as follows (generic base class interface).

/ return the collection of all objects in the database / the collection of specified objects [HttpGet] public virtual List GetAll (string token) {/ / check whether the user has permissions, otherwise a MyDenyAccessException exception base.CheckAuthorized (AuthorizeKey.ListKey, token) is thrown. List list = baseBLL.GetAll (); return list;}

However, there are many such return records, and paging is generally required, so the paging processing interface is defined as follows.

/ / query the database according to the criteria and return a collection of objects (for paging data display) / the collection of specified objects [HttpPost] public virtual PagedList FindWithPager (string condition, PagerInfo pagerInfo, string token)

The paging interface, in the results returned here, uses a generic class of PageList, which makes it easy for us to get the current records and totals, as defined below.

/ paging collection / object public class PagedList {/ return the total number of records / public int total_count {get; set;} / list collection / public List list {get; set }}

* the implementation of the entire paging processing Web API interface is as follows.

/ / query the database according to the criteria and return a collection of objects (for paging data display) / the collection of specified objects [HttpPost] public virtual PagedList FindWithPager (string condition, PagerInfo pagerInfo, string token) {/ / check whether the user has permissions Otherwise, a MyDenyAccessException exception base.CheckAuthorized (AuthorizeKey.ListKey, token) is thrown List list = baseBLL.FindWithPager (condition, pagerInfo); / / the format constructed into Json is passed var result = new PagedList () {total_count = pagerInfo.RecordCount, list = list}; return result;}

The Web API code for the client to call paging is as follows.

/ / query the database according to the criteria and return the collection of objects (for paging data display) / the conditions of the query / paging entities / the collection of specified objects public virtual List FindWithPager (string condition, ref PagerInfo pagerInfo) {var action = "FindWithPager" String url = GetTokenUrl (action) + string.Format ("& condition= {0}", condition); var postData = pagerInfo.ToJson (); List result = new List (); PagedList list = JsonHelper.ConvertJson (url, postData); if (list! = null) {pagerInfo.RecordCount = list.total_count / / modify the total number of records result = list.list;} return result;}

4. Hybrid framework interface integrates Web API interface.

In the process of the construction of the whole WebAPI platform and the integration of the hybrid framework, I develop and integrate each module in a relatively independent way, which unifies several ways from directly accessing the database, obtaining data from WCF services, and obtaining data through WebAPI calls, thus realizing a high degree of integration of the whole hybrid framework.

The core of the whole hybrid framework is to integrate each reusable module in a relatively independent way. We can quickly build a unified application platform on a certain basis.

The entire WebAPI platform, which includes the server content, publishes the corresponding WebAPI interface in the way of API controller.

In the independent module of each hybrid framework, we encapsulate the corresponding Web API client call processing, thus realizing the calling mode of Web API.

Under Win10, run the hybrid framework in Web API mode, and the effect of the body interface is as follows.

The interface of the independent module rights management system is shown below.

After reading the above, have you mastered the methods of Web API interface design experience? If you want to learn more skills or want to know more about it, you are welcome to follow the industry information channel, thank you for reading!

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.