zoukankan      html  css  js  c++  java
  • 自动生成接口文档的三种方式

    开始

    做开发经常会碰到这样的情况,前期写了接口文档,后端把需求改完没时间更新接口文档,想想就觉得崩溃了。那么有没有方法能自动生成接口文档来提高前后端的开发效率呢?

    自定义动态生成接口文档,手动部署

    在对外暴露的接口上添加一套自定义注解。注解可指定接口名称,请求 url,请求方式,请求参数,请求参数类型,返回参数,返回参数类型等信息。通过解析 controller 类上注解和方法上的注解,生成获取所有对外暴露方法的定义的接口,然后通过 web 页面呈现所有接口定义。

    项目组所有人使用Swagger,统一标准

    项目集成 Swagger 插件,添加Swagger依赖,前端人员访问 Swagger 生成的接口文档,查看和使用接口。

    使用Eolinker,根据需求导出不同格式接口文档

    后端开发直接将项目导入到Eolinker,完善需求时会自动生成接口代码,导入和导出均支持多种格式,通用性较高。
    使用地址:www.eolinker.com

    最后

    本文的思考来源于工作。项目接口文档本应该就是根据代码同时发布的,在多加一步操作,将生成的接口文档自动部署到服务上,就实现接口文档的自动更新,一劳永逸!

  • 相关阅读:
    CF1454F Array Partition
    leetcode1883 准时抵达会议现场的最小跳过休息次数
    leetcode1871 跳跃游戏 VII
    leetcode1872 石子游戏VIII
    CF1355C Count Triangles
    CF1245D Shichikuji and Power Grid
    CF1368C Even Picture
    CF1368D AND, OR and square sum
    CF1395C Boboniu and Bit Operations
    SpringBoot和开发热部署
  • 原文地址:https://www.cnblogs.com/dc20181010/p/14069839.html
Copyright © 2011-2022 走看看