项目接口书写心得(1)

目前在公司的工作主要是写前端的接口工作,会和前端的同事配合比较多;这里记一下,自己在项目前端接口书写过程中的一些错误,减少再犯的可能性。

1.接口的返回值的格式

--- list集合外面不需要再包一层(这里针对自己的项目而言)

2.接口的返回值和自己书写的文档要一致

--- 返回值类型

--- 返回值定义的名称

3.自己接口的业务逻辑要清楚,不要不知道自己这个接口是干嘛的?

4.有返回值就返回,没有的话,就是NULL

--- 不要返回一个空的,但是没有值

5.如果这个接口方法定义是有返回值的,那么在接收完参数之后,要return 结果。

--- 而不是继续让其往下执行(return map)

时间: 2024-10-06 03:40:21

项目接口书写心得(1)的相关文章

综合应用集成项目总结与心得

1 概述 这篇文档是本人第一次以项目负责人的角色来参加企业综合应用集成项目的开发,项目历时了近三个月的时间,虽说最后的结果不是让人非常满意,没有达到的自己预期,但是我在项目中的成长达到了自己的预期,为下一次项目打下了坚实的基础,文中记录了本人在项目中的成长历程和一些心得. 2 预期读者 数通畅联内部人员 相关IT技术从业人员 3 技术总结 3.1 AEAI DP AEAI DP应用开发平台是本次项目中的开发工具,基于AEAI DP快速开发出整个工程的菜单和功能页面,同时也为客户开发一些定制的po

(三) Angular2项目框架搭建心得

前言: 在哪看到过angular程序员被React程序员鄙视,略显尴尬,确实Angular挺值得被调侃的,在1.*版本存在的几个性能问题,性能优化的"潜规则"贼多,以及从1.*到2.*版本的面目全非,不过宽容点来看这个强大的框架,升级到ng2肯定是一件好事情,虽然截至目前ng2还存在或多或少需要完善的地方,但是ng2做到了留下并强化ng1好的部分,移除或改善其不好的部分,并且基于许多较新Web技术来开发,不去看从ng1迁移到ng2的门槛和工作量的话,ng2的编程体验是很酷炫的. 目前n

part11 Vue项目接口联调

何为项目接口联调? 前端代码编译好了  后端接口写好了 我们就需要去掉前端模拟数据干掉 用后端提供的数据.进行前后端的一个调试 如何联调? //想要手机通过ip地址链接我们的网站 我们前端的项目是通过 webpack-dev-server启动的 默认不支持通过ip访问 我们打开packge.json dev: --host 0.0.0.0 原文地址:https://www.cnblogs.com/-constructor/p/12324696.html

一次项目重构的心得体会

接手一老项目,经过几个月之后,实在顶不顺原来的架构,一样事情要干两件活,代码冗余复杂,给维护工作带来很多问题和隐患,趁着前段时间新需求比较少,遂与产品负责人沟通之后暂停新需求,先进行项目重构.于是就花了近一个月的时间对其架构进行重构,首先是将接入部分和业务处理部分分离,其次是将业务处理部分集中,再次是引入内存数据库,实现业务处理部分无状态,将所有状态保持在内存数据中,从而使得业务处理进程可以多个进程并行,并且可以进行业务处理模块的无间断更新.重构完之后可以说是脱胎换骨了,其中有些心得和体会分享一

我的2016年终总结(PF项目框架设计心得分享 2.0rc)

在无数的日夜里,熬出了多少的黑眼圈,致勤勤恳恳工作的各位朋友与自己.每到了年末的时候总想写的什么,主要是为了回顾以往一年里到底做了什么,这便是年终总结的主要意义.在此我将要总结的是和我在技术层面上成长的一个项目,那便是开源的plain framework(简称PF),我会在这里分享一些关于程序设计的一些心得. 起源 2014年的7月左右,本着对于自己技术的不断提高,我正式将之前的plain server项目进行整理,准备写一个可以方便使用的框架.具体原因主要是发觉自己在工作中非常需要,以及技术层

C# 枚举在项目中使用心得

阅读目录 基本介绍 使用注意 使用方法 扩展用法 本文主要是我在项目中对C#枚举的使用心得,如有不足的地方欢迎您指出. 一.基本介绍  枚举是由一组特定常量构成的一组数据结构,是值类型的一种特殊形式,当需要一个由指定常量集合组成的数据类型时,使用枚举类型.枚举声明可以显式地声明 byte.sbyte.short.ushort.int.uint.long 或 ulong 类型作为对应的基础类型.没有显式地声明基础类型的枚举声明意味着所对应的基础类型是 int. 在代码中使用枚举,可以将以前笨拙的代

个人阅读作业2:关于项目经历的心得

一.No Silver Bullet: Essence and Accidents of Software Engineering 在Fred Brooks所写的这边文章中,他认为曾经传说的年代中银色子弹可以有力针对狼人,是一个解决问题的良剂.然而,在软件工程中却不是如此,软件工程中有不可避免的诸多问题,主要由复杂性(complexity),软件整合(conformity),可变性(changeability)和不可见性(invisibility)等组成. 复杂性(complexity) 在硬件

第一次项目发布的心得体会

昨晚, —— 不, 应该是今天凌晨, —— 注定是个不简单的时刻. 我入职后参与的第一个项目发布,而且自己所做的工作是数据订正,涉及用户数据的操作总是非常敏感而重要的.因此,心理还是比较紧张的. 果然是真实环境更能锻炼人.虽然事先检查了好几遍,可是实际执行时还是出问题了. 事情是这样的: 我写了几个 .py  脚本用来操作数据库,需要更新10000多个用户的资源记录,每个用户的资源记录涉及好几个数据库的几张表.  在具体执行时,发现每一个用户的资源更新都比较慢,——但实际上,仅从操作上来看并不能

做项目过程一点心得

第一,要多实践.看书呢有2个左右,第一是可以入门.第二是往深了学,很多知识和api难以自己探索到,毕竟不是自己发明的语言和平台,得学别人已经提供的平台和知识.但是光看书也不行,主要有以下缺陷: 1)东西(代码)再简单,自己做不出来等于零,只有羡慕的份.没有像样的东西拿出来既无法说服人,自己也心虚.2)也拿不出自己的核心产品来挣钱.脑子里光有许多想法,甚至也有大致的思路,但就是拿不出东西来.3)在实际开发中同样会遇到很多问题,第一手的开发心得不是书上能教你的,别人的心得告诉你你也不懂,所谓懂了也是