易文档,链接:https://easydoc.top,专业编写API文档的工具,支持HTTP文档,markdown文档,富文本文档
还支持在线接口测试,一键生成mock配置,前端不用等服务端开发完接口就能进行测试了。
不管是编写体验还是预览,专业性和美观性都会大大超越其他同类产品
看下他的预览效果,示例项目
市面很多http接口文档的编写都是直接写markdown文档,这种编写起来特别麻烦。易文档在http文档方面有做专门的处理,做了很多优化体验,比如按tab就可以自动下一个输入框,可以保存一些常用的参数,方便快速引用进来,还有不限层次的子参数,参数行顺序调整。
特别强大的是,他的http文档可以自定义参数块和描述块,比如失败和成功返回的参数不一样,我们可以添加两个参数块,分别对应成功响应参数、失败响应参数
如果你想给每个返回都提供一个示例或者说明,也都没问题,可以自己添加描述块。而且块的顺序是可以调整的,非常方便。
更多使用技巧,请查看 必备使用技巧