请问怎么样才能愉快的前后端进行对接

[xianyv]

我现在跟前端对接的时候太痛苦了, 怎么才能让前端看到接口就知道这个接口用在哪里? 还有就是怎么才能让前端记住部分通用字典(这个可能有点过分)?

[bojackhorseman]

写好文档😏

[gauzung]

1.让前端看到接口就知道这个接口用在哪里；
2.让前端记住部分通用字典

我的评价是——换个后端

[cxe2v]

写好文档[微笑]

[xianyv]

@gauzung 哈哈哈哈,确实这两个要求太过分了

[zhuangjia]

写好文档

[xianyv]

@bojackhorseman
@cxe2v 怎么才能算是一个好文档? 因为业务频繁变动,有的时候实在是就把文档更新给忘记了

[zhuangjia]

1.让前端看到接口就知道这个接口用在哪里
没有默契就在开发前和前端对照设计图确认开发方案，并确保后面接口文档与此一致
2.怎么才能让前端记住部分通用字典
通用字典放到文档里，每个需要该字典的地方都链接过去

[h1104350235]

写好文档

[xianyv]

@zhuangjia 好的谢谢

[zhuangjia]

@xianyv
> 因为业务频繁变动,有的时候实在是就把文档更新给忘记了

前端怼我一句话：你文档没更新，我改不了

[cxe2v]

@xianyv #6 你都能把文档给忘了，那可不就得口耳相传接口设计了

[zinete]

我是前端， 有个 swagger docs 链接就成

[xianyv]

@cxe2v 这点我是需要改改的

[xianyv]

@zinete 不让用,文档手写

[iDontEatCookie]

我们后端给我的接口都是 xx 模块 /xx 页面 /xx 时候调用接口 这样写好的 字典要么是在接口参数注释里写好 要么是统一接口返回的

文档不更新 总不能让我看你后端代码接接口吧？

[bojackhorseman]

我们用的`swagger-typescript-api`根据 swagger json 文件生成 api 文档，类型提示，调用方法都有，特别方便，不用手写方法了。

[zoharSoul]

让前端自己写接口, 后端写到 rpc 层完事

[TangYuSen]

昨天上课的老师说了，软件开发中，敲代码只占了很小一部分的时间（他说最多 10%），更多时间是在写文档，开会交流，要我们牢记这点，其实我也赞同，我觉得我周围的人对文档很不重视，只顾敲代码完成功能就完事了，包括我，我自己也在学着去写文档了，但写文档来的正反馈真的没有敲代码完成一个小功能来的爽，感觉写文档，更多的是对自己工作负责吧，我想或许这是成为高级工程师的要点之一吧（我专业是软工）

[DShen]

自己做全栈😂

[deplivesb]

锻炼身体，当后端打不过你的时候，他自然能和你愉快的对接