The api document is a technical content delivery file, which contains instructions on how to effectively use and integrate the API. Is a concise reference manual, which contains all the information needed to use API, and introduces functions, classes, return types, parameters, etc. It is introduced in detail and supported by tutorials.
Traditionally, API documents are completed by using traditional content creation and maintenance tools and text editors. API description formats such as OpenAPI /Swagger specification have an automatic documentation process, which makes it easier for teams to generate and maintain API documents.
Extended data:
Windows API
The API function is contained in the dynamic link library file under the Windows system directory. Windows API is a set of predefined Windows functions, which are used to control the appearance and behavior of various Windows components. Every action of the user will cause one or several functions to run to tell Windows what happened.
This is very similar to the natural code of Windows to some extent. Other languages just provide an automatic and easy way to access the API. When you click a button on the form, Windows will send a message to the form, and VB will get this call and generate a specific event after analysis.
It is easier to understand that Windows system is not only a great service center, but also coordinates the execution of application programs, the allocation of memory and the management of system resources.
Calling various services in this service center (each service is a function) can help applications open windows, draw graphics and use peripherals. Because these functions serve applications, they are called application programming interfaces, or API functions for short.
WIN32 API is the application programming interface of MicrosoftWindows 32-bit platform. Any application executing in Windows working environment can call Windows API.
linux API
In linux, the user programming interface API follows the-POSIX standard, which is the most popular application programming interface standard in UNIX. POSIX standard is a standard system jointly developed by IEEE and ISO/IEC.
Based on the existing UNIX practice and experience at that time, the standard describes the system call programming interface API of the operating system, which is used to ensure that the application program can be transplanted and run on various operating systems at the source program level. These system call programming interfaces are mainly implemented by C Library (LIBC).
References:
Baidu encyclopedia -api