iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringBoot如何自动生成API文档详解
  • 361
分享到

SpringBoot如何自动生成API文档详解

2024-04-02 19:04:59 361人浏览 泡泡鱼

Python 官方文档:入门教程 => 点击学习

摘要

前言 在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用excel或者Word来写,高级一点的就采用a

前言

在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用excel或者Word来写,高级一点的就采用api管理平台手工录入,一个项目有上千上万个接口,天啊,这是多么大的工作量,在接口维护的时候更加痛苦,为了解决这样的事我们可以借助 japi 这个项目来完成RESTFul文档的自动生成,完全基于注释生成,更多详细配置可查看https://GitHub.com/dounine/japi。

使用说明

克隆项目下来


git clone Https://github.com/dounine/japi.git

编译打包


cd japi/java
gradle install -xtest

运行JAPI后台管理


cd japi/java
gradle bootRun

运行JAPI文档界面


cd japi/node
node app.js

生成RESTFul文档

Maven项目


<dependency>
    <groupId>com.dounine.japi</groupId>
    <artifactId>client</artifactId>
    <version>1.0</version>
</dependency>

gradle项目


compile group: 'com.dounine.japi', name: 'client', version: '1.0'

编辑resources/japi.properties配置文件


japi.name=test
japi.uuid=43a600877430438596de3D330e4bd06e
japi.version=1.0.0
japi.author=lake
japi.url=http://192.168.0.123:8080
japi.description=this is project description.
japi.createTime=2017-02-23 10:44:44
japi.icon=/home/lake/github/japi/html/img/loGo.png
japi.server=http://192.168.0.179:7778
japi.server.username=japi
japi.server.password=japi123

编写一个action



@GetMapping(value = "v2/list")
public Result hots(@Validated({User.UserDEL.class}) User user) throws RuntimeException {

    return null;
}

编写一个API生成类

JapiCreateTest.java


@Test
    public void testCreate(){
        JapiClient.setPrefixPath("/home/lake/github/test-japi/java/");//项目路径前缀
        JapiClient.setpostfixPath("/src/main/java");//项目路径后缀

        JapiClient.setProjectJavaPath("client");//主项目地扯
        JapiClient.setActionReletivePath("com/dounine/test-japi/action");//相对主项目action包所在路径
        //JapiClient.setIncludeProjectJavaPath(new String[]{"api"});//主项目中关联的其它项目包路径
        JapiClient.setIncludePackages(new String[]{"com.dounine.test-japi"});//关联的包,用于准确快速搜索
        JapiClient.saveHistory(true);//是否保留本地历史版本
        JapiClient.setFlushServer(false);//强制同步本地与服务器所有的版本(会先删除服务器以前的历史版本)

        IProject project = ProjectImpl.init();
        JapiClientStorage japiClientStorage = JapiClientStorage.getInstance();
        japiClientStorage.setProject(project);
        japiClientStorage.autoSaveToDisk();//自动使用到本地磁盘==> 用户目录/.japi-client/
        new JapiClientTransfer().autoTransfer(japiClientStorage);//文件传输到主服务器.
    }

最后访问浏览器 http://localhost:7777

就可看到RESTFul文档登录

使用自己的帐号登录就可以看到所有项目

进入项目看详细RESTFul接口

使用场景

JAPI最适合在SpringCloud这样的分布式多模块项目中使用,内置强大的正则表达式,这会让代码注释更加规范,区别于swigger这类使用侵入式注解生成文档的,JAPI是完全基于标准注释生成的,支持强大的JSR303或者是自定义注解。

开源精神

欢迎有意向的同学加入JAPI项目组将它改造得更好。

总结

到此这篇关于SpringBoot如何自动生成API文档的文章就介绍到这了,更多相关springBoot自动生成API文档内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: SpringBoot如何自动生成API文档详解

本文链接: https://www.lsjlt.com/news/131567.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • SpringBoot如何自动生成API文档详解
    前言 在做项目的时候,如果项目是前后分离的,后端一定要和前端或者是移动端对接接口,那么问题来了,接口是不是要自己写给他们看,一般的会采用Excel或者Word来写,高级一点的就采用A...
    99+
    2024-04-02
  • SpringBoot是怎么自动生成API文档的
    这篇文章主要讲解了“SpringBoot是怎么自动生成API文档的”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“SpringBoot是怎么自动生成API文档的”吧!前言在做项目的时候,如果项...
    99+
    2023-06-20
  • Typescript中interface自动化生成API文档详解
    目录前言UI层面数据层面我们需要的数据结构简单解释一下jsdoc格式AST解析技术选择为什么放弃babelts-morph自动化生成代码总结前言 最近在搞react组件库,这两天搞定...
    99+
    2022-12-27
    typescript 生成文档 typescript api typescript的interface
  • SpringBoot如何优雅的整合Swagger Api自动生成文档
    目录前言 整合swagger api 自定义配置信息 简单使用 Swagger常用注解Api标记 ApiOperation标记 ApiParam标记 ApiModel标记 ApiMo...
    99+
    2024-04-02
  • SpringBoot怎么整合Swagger Api自动生成文档
    本篇内容主要讲解“SpringBoot怎么整合Swagger Api自动生成文档”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“SpringBoot怎么整合Swagger Api自动生成文档”吧!...
    99+
    2023-06-20
  • SpringBoot的API文档生成工具SpringDoc使用详解
    目录前言SpringDoc简介使用集成从SpringFox迁移结合SpringSecurity使用测试常用配置总结参考资料前言 之前在SpringBoot项目中一直使用的是Spri...
    99+
    2024-04-02
  • Babel自动生成Attribute文档实现详解
    目录1. 前言2. 开发自动生成属性文档插件2.1 生成Babel插件模板:2.2 转换思路详解:2.3 单元测试用例:2.4 AST分析详解:2.5 插件开发过程:2.5.1 定义...
    99+
    2022-11-13
    Babel生成Attribute文档 Babel Attribute
  • Laravel使用Apidoc注解自动生成Api接口文档
    本教程从零开始搭建laravel项目,并安装Apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持 多应用/版本、Markdown文档、在线接口调试、接口生成器、代码模板生成器、Mock调试数...
    99+
    2023-09-05
    laravel php doc 后端 api
  • SpringBoot使用swagger生成api接口文档的方法详解
    目录前言具体例子maven配置项目application.yml配置springApplication添加swagger注解在控制层添加swagger注解前言 在之前的文章中,使用m...
    99+
    2022-11-13
    SpringBoot swagger生成api接口文档 SpringBoot 生成api接口文档 SpringBoot swagger
  • 解析如何自动化生成vue组件文档
    目录一、现状二、社区解决方案2.1、业务梳理三、技术方案3.1、Vue文件解析3.2、信息提取3.2.1、可直接获取的信息3.2.2、需要约定的信息四、总结五、展望一、现状 Vue框...
    99+
    2024-04-02
  • spring boot集成smart-doc自动生成接口文档详解
    目录前言功能特性1 项目中创建 /src/main/resources/smart-doc.json配置文件2 配置内容如下(指定文档的输出路径)3 pom.xml下添加配置4 运行...
    99+
    2024-04-02
  • 一文详解Golang如何生成Excel文档
    本篇文章给大家带来了关于Golang的相关知识,其中主要跟大家介绍怎么用Golang生成Excel文档 ,感兴趣的朋友下面一起来看一下吧,希望对大家有帮助。基于数据生成 Excel 文档是一个很常见的需求,本文将介绍如何使用 Go 的 Ex...
    99+
    2023-05-14
    Excel 后端 Go
  • Springboot整合Springfox生成restful的在线api文档
    目录Springfox是什么,有什么用?Springfox的依赖Springfox的配置测试的ControllSpringfox是什么,有什么用? Springfox基于Swagge...
    99+
    2024-04-02
  • django怎么自动生成接口文档
    Django没有内置的功能来自动生成接口文档,但是可以使用第三方工具来实现自动生成接口文档。 以下是一些常用的自动生成接口文档的工具...
    99+
    2023-10-23
    django
  • SpringBoot2配置Swagger2生成API接口文档详情
    目录一、Swagger2介绍二、配置Swagger21、引入相关依赖2、创建swagger的配置类3、在启动类上添加注解扫描swagger的配置类,进行测试4、API模型5、定义接口...
    99+
    2024-04-02
  • 一文详解如何在前端中动态生成API接口
    本篇文章给大家带来了关于前端的相关知识,其中主要介绍了怎么在前端中动态的生成API接口 ,下面一起来看一下,希望对大家有帮助。在ts横行的时代,接口请求和返回参数定义类型成了繁琐的一件事情,在这样的情况下,我们可以通过node服务,来进行自...
    99+
    2023-05-14
    node API
  • java如何实现自动生成数据库设计文档
    目录前言实现步骤main方法类全部代码表qrtz_blob_triggers表qrtz_calendars表qrtz_cron_triggers前言 以前我们还需要手写数据库设计文档...
    99+
    2024-04-02
  • PHP如何使用Swagger生成好看的API文档
    本文小编为大家详细介绍“PHP如何使用Swagger生成好看的API文档”,内容详细,步骤清晰,细节处理妥当,希望这篇“PHP如何使用Swagger生成好看的API文档”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧...
    99+
    2023-07-05
  • Babel怎么实现自动生成Attribute文档
    本篇内容主要讲解“Babel怎么实现自动生成Attribute文档”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“Babel怎么实现自动生成Attribute文档”吧!1. 前言利用Babel自动...
    99+
    2023-07-04
  • 怎么给ABAP类自动生成帮助文档
    本篇内容主要讲解“怎么给ABAP类自动生成帮助文档”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“怎么给ABAP类自动生成帮助文档”吧!Social media 在SP0开发的时候,建了CL_SO...
    99+
    2023-06-04
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作