API automatic management and sdk, document automatic generation method

Abstract

The invention provides an automatic API management method. A service supplier provides an introducing assembly, and interference opening parameters and attributes are configured; the service supplier starts back-end service; a service supplying address is configured in a publishing system, and API metainformation is loaded from the address; the API metainformation is located in a Prepared list, and API is switched into a Prepared state; dependency information is remotely loaded from the address; the service supplier checks the drawn API Prepared list, and submits the API metainformation after verifying that the API metainformation needing to be published is correct, and the API is switched into a Prototyped state and waits to be published; an application is submitted to publish the API online, a manager ratifies publishment after verifying that the API is correct, and the API is switched into a Published state and serves the outside officially. Human cost for API publishing and managing and time cost for developing SDK of various language versions and rewriting documents are reduced, and the working efficiency of technicists is improved.

Description

technical field [0001] The invention relates to the technical field of the Internet, in particular to an API automatic management method, an SDK, and a document automatic generation method. Background technique [0002] With the diversified development of the Internet era, more technicians are devoting energy to the development of network applications, and are committed to lowering the threshold of software and application development. The trend of product service and technology opening is becoming more and more obvious. Servitization of Internet products and infrastructure capabilities has become the general trend. However, the service-oriented process of many medium and large-scale application products is bound to be accompanied by the integration and opening of many APls (Application Programming Interface, application programming interface, a contract for interaction between technicians and software programs). Rapid iteration of API versions, a large number of new and de...

AI Technical Summary

Problems solved by technology

[0008] 5. Restart the service to make the new service configuration take effect

[0014] 1. After the developer completes the service development work, he still needs to perform configuration work, which reduces efficiency due to duplication of work

[0015] 2. In actual scenarios, if you need to publish a large number of APIs in batches, you need to manually write a large number of configuration files, or perform a large number of manual configurations, which is difficult to achieve in a short time

[0016] 3. The interaction between the system and the backend requires specific general protocol specifications, such as json and protobuf to work, and there is a performance bottleneck

[0017] 4. If there are multi-party APIs that need to be connected to the system, it may be necessary to introduce multi-party dependencies, resulting in frequent maintenance and upgrades and subsequent various problems

[0018] 5. Repeatedly update and maintain the SDK code, wasting a lot of labor costs

[0019] 6. Repeatedly writing and modifying API documents wastes a lot of labor costs

Images