合格的编写接口只需要明白这些

一、接口概述

        根据系统功能，一般接口可以概括为增、删、改、查这四类，对于接口中的参数，我们都是要进行校验的，如

• 必填项和非必填项
• 参数合法性（防止sql注入、xxs攻击等）
• 时间类型、数字类型、规则验证（手机号、身份证等）
• ..............

同时为了确保接口的安全性，可以增加密钥或token来增加调用接口的合法性,严格控制返回的参数，避免展示敏感、无用的信息,对于错误信息，我们要尽可能抛出明确的异常。

二、构造接口结构

        首先我们做接口的目的，就是返回固定结构的JSON数据，这个结构是需要先确定的才好进行后面的开发工作,构造结构我们可以通过字符串拼接或通过实体对象进行构造，推荐采用实体构造的方式，因为太复杂的结构用拼接的话会拼到奔溃的😂，常见的接口结构如下图所示

比如我们想构造这样的例子，一个学校、班级、学生这样的关系该如何构造呢？

结构示例

{

    "success": true,

    "message": "查询成功",

    "data": {

        "SID": "6D7DDC59-EFB7-46D4-B039-6F7FA45ED156",

        "SchoolCode": "",

        "SchoolType": ""