Re: [请益] 有人的公司也没有提供API文件的吗

楼主: lovdkkkk (dk)   2023-01-02 11:09:57
※ 引述《cv123741 (cv123741)》之铭言:
: 标题: [请益] 有人的公司也没有提供API文件的吗
: 时间: Sun Jan 1 19:11:08 2023
:
: 安安
:
: 小弟刚转前端,进到一家接案公司写网页,工作大概9成都在接API,
: 但公司内部没有提供api规格文件让我参考,
: 导致每次我都要通灵,
: 不然就是缠着后端不放,
:
: “沟通”大概占了我1/3到1/2的开发时间,
:
: 公司虽然有说以后会要求有文件,但迟迟没下文...
:
:
: 有没有人也遇过同样问题的,这样要如何解决?
:
: 还是只能出下下策直接离职比较省事
几种可能做法
1. 写在 issue comments
假如有用 github 开 issue 给后端做 API,
请后端完成后将他测试时的 code 贴上去
这对新 API 应该没什么问题,旧有的就不一定
2. 记在 Postman
开一个 Postman 帐号,下次去找后端当面边问边记录到 Postman,
然后问后端未来遇到不懂的 API 能不能直接请他补进 Postman,
通常应该是会愿意,自己补应该比问答后再补省事
Swagger 看开发环境支援什么做法,如果只能用注解写文件就不太好做,
如果能直接侧录或融入开发 config 的话就比较好
3. 推 api 测试
类似 1 也是请后端写测试 code,但这可扩及旧有 API,
但前期投入会比较多不一定推得成,
如果有办法就自己开个头把前置环境都弄好,
再像补 Postman 一样需要时请后端补
作者: MoonCode (MoonCode)   2023-01-03 18:08:00
帮 QQ
作者: scorpion (蝎)   2023-01-04 01:24:00
卑微的前端。
作者: lovetzuyu23   2023-01-04 23:04:00
大部分9成的公司都没有啦,前端的我是自己找到一套api文档管理套件做管理

Links booklink

Contact Us: admin [ a t ] ucptt.com