写一个接口该注意什么？

@Api(tags = "A部分接口") //这个注解我们会用在类上

@ApiOperation（"接口1"）

@ApiImplicitParams（{
  @ApiImplicitParam（name=参数1 ，value=参数1）
}）

//一般情况下，我们都会在接口的实现层，写业务之前都会去判断一下参数
if(StringUtils.isEmpty(参数1)){
  throw new XXException("enum.code","enum.msg")
}
//我们也会根据业务的不同，不一定是判断非空，比如说判断一个手机号或者身份证是否格式正确，我们就要用正则去判断。
//上方enum 就是我们自己去定义的错误码枚举类。通常包含module，code，msg，args。我们也要做统一的异常处理类，因为这个XXException是我们自己定义的异常类
//所以我们通常要写一个GlobalExceptionHandler
//同时，我们接口的返回也是要定义好格式和枚举类的
return R 或者 AjaxResult
//这个R和AjaxResult，就是我们通常定义的返回类，里面包含了code，msg，data

@RestControllerAdvice
public class GlobalExceptionHandler {
    private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);

    @ExceptionHandler(BaseException.class)
    public AjaxResult baseException(BaseException e,HttpServletRequest request)
    {
        String requestURI = request.getRequestURI();
        log.error("请求地址'{}',参数为：'{}'，发生异常为：'{}',异常码为：'{}'", requestURI, e.getArgs(),e.getDefaultMessage(),e.getCode());
        AjaxResult ajaxResult = new AjaxResult(Integer.parseInt(e.getCode()),e.getDefaultMessage());
        return ajaxResult;
    }

    @ExceptionHandler(RuntimeException.class)
    public AjaxResult handleRuntimeException(RuntimeException e, HttpServletRequest request)
    {
        String requestURI = request.getRequestURI();
        log.error("请求地址'{}',发生未知异常.", requestURI, e);
        return AjaxResult.error(e.getMessage());
    }

    /**
     * 系统异常
     */
    @ExceptionHandler(Exception.class)
    public AjaxResult handleException(Exception e, HttpServletRequest request)
    {
        String requestURI = request.getRequestURI();
        log.error("请求地址'{}',发生系统异常.", requestURI, e);
        return AjaxResult.error(e.getMessage());
    }


}