共计 673 个字符,预计需要花费 2 分钟才能阅读完成。
编写和保护 API 文档这个事件,对于后端程序员来说,是一件宜人但又不得不做的事件,咱们都不喜爱写文档,但除非我的项目前后端代码都是本人写的,否则 API 文档将是前后端合作中一个不可或缺的沟通界面。既然不可避免,那就想方法弄个轮子吧。人生苦短,必须偷懒。无图无假相,生成文档的成果如下:
相比 Swagger 要写一堆注解,Spring RestDocs 须要写测试用例,能力生成 API 文档。Eolinker 具备无痛集成的特点,你只需花几分钟就能晓得它怎么用了。
疾速开始
产品反对几种创立 API 文档的形式:
1. 手动创立文档:适宜所有团队;
2. 依据代码注解主动生成文档:适宜应用过或正在应用 Swagger 产品来主动生成文档的团队。
3. 依据代码模板疾速创立 API 文档:适宜所有团队。
接下来你只管好好写代码,生成 Api 文档的工作就能够交给 Eolinker 了,你不须要再为额定编写和保护文档而懊恼。
性能个性
1、代码即文档 只有语法合乎肯定的代码标准,有正当的正文,就能够间接导出文档。
2、反对导出 HTML 便捷的导航和接口查看界面;可本地预览,或者部署到 HTTP 服务器。举荐部署到服务器,不便前后端开展合作。
3、更多个性反对接口搜寻、反对不同版本、自定义扩大等。
简洁的文档
再好用的货色,如果没有文档阐明,他人也无从动手。为了让大家尽快上手,Eolinker 筹备了一份极简的文档阐明,确保你在几分钟就能用上 Eolinker。花 5 分钟不到就能意识一个进步工作效率的工具,让你把更多的工夫花在更加有价值的事件上,你确认不看一下吗?
应用地址及帮忙文档:www.eolinker.com
正文完