Don't know how to read API interface documents? Smart you'll see

How do API game interfaces connect

Application Programming Interface

What is the API

The full English name of the API interface is "Application Programming Interface". In layman's terms, it is: application programming interface. It is the most basic thing in the operating system, through which computer hardware operations can be performed. Nowadays, it can be seen everywhere in life in various industries. Water and electricity bills, gas bills, landline broadband, and transportation fines can all be paid on mobile phones, thus eliminating a series of cumbersome operations. This year's COVID-19 statistics show the news and almost every hour there will be statistical confirmed data and other information, but behind the data is the API running silently.

api游戏接口到底怎么对接
How do API game interfaces connect

API is like a channel for data transmission. The entry needs to request data, which is equivalent to a customs clearance password, while the exit needs to return results. The user of the interface doesn't need to care about how the interface is implemented, only whether he can get the final return result of the interface. The provider of the interface needs to define the interface request parameters, response contents, etc., and also needs to pay attention to the performance of the interface, whether it can meet the high concurrent calls, and how stable the interface is In short, an API is a predefined function.

api游戏接口到底怎么对接
How do API game interfaces connect

API documentation The English "API developer Doc" is the most troublesome thing for developers. In addition to developing API interfaces, they also need to write well API documentation

API interfaces are generally divided into interface description, interface address, request method, request parameters, corresponding contents, error code and examples.

1. Interface description

Briefly describe the logic and function of the interface

2. Interface address

The formal URL of the interface and the URL of the interface test. The demander obtains the response content by calling the interface URL

3. Request method

Generally speaking, the most common request methods for interfaces are get and post, that is, read interface and write interface. Through these two methods, the addition, deletion, query and modification of data can be realized. Addition, deletion and modification are essentially written actions.

4. Request parameters

That is, the name and rules of the field name to be requested: what fields are they, what type of field are they, whether they are required, etc

5. Response content

Field names and rules returned by the interface.

Note: Most developments often do not list all fields, only list more important fields. When you find that there are no fields you need in the interface document, don’t rush to find development. You can check whether there are any fields you need in the example.

6、error code

Classify the interface errors with codes, so as to quickly find the cause of the error and solve the problem.

7. Examples

The content of the response when actually called.

No matter whatAPI game interfaceOr you should have a certain understanding of any other interface docking. Being a product manager is difficult because there are too many things you need to understand, and being a product manager is also easy, because some things do not require proficiency, just understand a little. Basically, you can understand the above parts and there is no problem in understanding an API document. When connecting with technicians, you will not be criticized for being a fool. In short, if the product manager does a good job, he will be glorious. If he doesn't do it well, everyone will shout and beat him. It's simply a road of no return, and we are already going further and further on this road...

Login / registration
Administrator Login