前几天因为需求比较急,写完接口没有像往常一样“手写文档”,于是尝试使用apipost自动生成文档,整体体验非常不错,省去了写文档的时间。后来和前端沟通之后,觉得还是少了一些东西。之前在我手写文档时,遇到一些不能直接根据接口名称就可以定位到原型位置的地方,我会在接口下面贴上该接口在原型的哪里,但是apipost不能编辑生成的在线文档,所以不能插入图片。后来我又发现可以在接口的地方创建“文本”,并把接口与原型的对应关系放在这个文本里,就很好的解决了我的问题。到这里,其实apipost已经能满足我90%的需求了,但是对于看文档的前端同学来说,好像还差一步,就更便捷了。
如果在“文本中”,可以插入类似“路由链接”,点击这个链接就可以跳到对应接口在的地方,那就更完美了。
祝apipost越来越好。
收到您的建议,我们会在后续版本进行优化,后续会及时进行反馈