java开发第一次和前端交互,需要提供给前端什么内容?

Question

一个页面从老项目迁到新项目来. (老项目代码有的,但是没controller,只找到操作表的service)
就是一个查表再返回查到内容的页面.
之前呆的公司,是经理直接给我们接口开发文档, 有url 有入参出参. 不用和前端交互.
现在换家了,要和前端交互,需要给他什么啊?
就发一个url和入参出参吗?
要整理成什么格式发他吗?

Answer 1

一般 看 规范 没有 特别 要求 可以自己 写个文档 。发给 前端 。

文档 一般 有
接口 地址 url
接口功能/模块：比如：首页-商品列表 筛选
接口类型：post/get ....
接口参数：...
参数名 参数作用 是否必填 参数类型
id 商品 id 是 number
接口参数 类型：string，json....(可写，可不写)

也可以用 在线文档 apipost等等工具