zoukankan      html  css  js  c++  java
  • 替代Swagger?试试这个新工具!

    编写和维护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

  • 相关阅读:
    java数组------数组基本使用和3中初始化方式
    java面向对象-------final关键字
    java面向对象------- 多态
    java面向对象------- 封装
    Android 音视频开发(五):使用 MediaExtractor 和 MediaMuxer API 解析和封装 mp4 文件
    Android 音视频开发(四):使用 Camera API 采集视频数据
    音频 PCM 数据的采集和播放
    http协议的学习
    Kotlin入门学习笔记
    RxJava笔记
  • 原文地址:https://www.cnblogs.com/dc20181010/p/14196647.html
Copyright © 2011-2022 走看看