One, both sides of the unified Interface Development documentation
In order to improve the development efficiency and communication convenience, it is necessary to establish normative development documents.
General protection of the interface function or page, interface address, interface parameters, interface return value and other instructions.
Reference Document Format:
Second, pay attention to the following
- Sub-version, for the back of the interface upgrade good intentions.
- Provide the key and token. Ensure that data is not tampered with.
- Read data with GET, modify data with post.
- Interface return value format uniform structure. Output in JSON format
- The interface logs the log. Log request parameters, memory consumption, response time, response length. Easy follow-up optimization.
- Provides a uniform error code. Each number represents an error that needs to be described in the documentation. Error sub-system errors and business logic errors. Create an interface document.
- Records the purpose of each interface, the parameter list, and the return value description. Also give examples of use.
'). addclass (' pre-numbering '). Hide (); $ (this). addclass (' has-numbering '). Parent (). append ($numbering); for (i = 1; i <= lines; i++) {$numbering. Append ($ ('
'). Text (i)); }; $numbering. FadeIn (1700); }); });
The above describes the PHP Development app interface considerations, including the aspects of the content, I hope that the PHP tutorial interested in a friend helpful.