文档章节

Regan_API_SpringBoot 一个基于注释生成JAVA API文档的接口平台

Jeff_Regan
 Jeff_Regan
发布于 2018/08/31 14:19
字数 330
阅读 261
收藏 6

Regan_API_SpringBoot

项目介绍

Regan_API_SpringBoot 文档项目 Regan API 项目是基于注释自动生成api文档,很大缩短了开始与后期维护API接口文档的时间。Regan API 利用jdk提供的Doclet 类读取文档注释,可手动配置需要读取的文件,同时增加了读取过滤指定方法过滤等功能。

/**
* 用户管理
* @action /user
* @author zhangby
* @date 2018/6/12 下午3:26
*/
public class UserController extends Controller {
/**
 * 用户登录功
 * @title 登录接口
 * @param username|用户名|string|必填
 * @param password|密码|string|必填
 * @resqParam code|用户名|String|必填
 * @resqParam data|数据|object|非必填
 * @resqParam msg|消息信息|String|必填
 * @respBody {"code":"000","data":"","msg":"success"}
 * @requestType post,get
 * @author zhangby
 * @date 2018/6/12 下午4:23
 */
public void login() {
    renderJson(Kv.create().set("code","000"));
}
}

文档: https://zhangbiy.github.io/regan_api_doc/#/

版本

软件架构

软件架构说明 Regan API 基础项目基于 springboot 开发,前端基于飞冰开发的API接口文档管理项目。

© 著作权归作者所有

Jeff_Regan
粉丝 4
博文 5
码字总数 6538
作品 3
海淀
程序员
私信 提问
Regan_Jeff/Regan_API_SpringBoot

ReganAPISpringBoot 项目介绍 ReganAPISpringBoot 文档项目 Regan API 项目是基于注释自动生成api文档,很大缩短了开始与后期维护API接口文档的时间。Regan API 利用jdk提供的Doclet 类读取文...

Regan_Jeff
2018/09/04
0
0
基于注释自动生成 API 文档 - Regan API SpringBoot

ReganAPISpringBoot 项目介绍 ReganAPISpringBoot 文档项目 Regan API 项目是基于注释自动生成api文档,很大缩短了开始与后期维护API接口文档的时间。Regan API 利用jdk提供的Doclet 类读取文...

Jeff_Regan
2018/08/31
2.9K
2
smart-doc

smart-doc是一个java restful api文档生成工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法。smart-doc完全基于接口源码分析来生成接口文档,完全做到零注解侵...

上官胡闹
2018/08/23
8.9K
7
Spring Boot学习笔记

多模块开发 [SpringBoot学习]-IDEA创建Gradle多Module结构的SpringBoot项目 RabbitMQ RabbitMQ 安装 linux安装RabbitMQ详细教程 Ubuntu 16.04 RabbitMq 安装与运行(安装篇) ubantu安装...

OSC_fly
2018/07/26
0
0
SpringBoot 集成Mqtt,protobuf服务端搭建

代码已开源在GitHub,如果有帮助欢迎star。 Architecture Server side 构成 broker (mqtt核心:用于消息的发送管理) Application Server用于处理RestFul的请求,转发为Mqtt消息 Client side ...

braincs
05/23
0
0

没有更多内容

加载失败,请刷新页面

加载更多

前端技术之:Prisma Demo服务部署过程记录

安装前提条件: 1、已经安装了docker运行环境 2、以下命令执行记录发生在MackBook环境 3、已经安装了PostgreSQL(我使用的是11版本) 4、Node开发运行环境可以正常工作 首先需要通过Node包管...

popgis
今天
5
0
数组和链表

数组 链表 技巧一:掌握链表,想轻松写出正确的链表代码,需要理解指针获引用的含义: 对指针的理解,记住下面的这句话就可以了: 将某个变量赋值给指针,实际上就是将这个变量的地址赋值给指...

code-ortaerc
今天
4
0
栈-链式(c/c++实现)

上次说“栈是在线性表演变而来的,线性表很自由,想往哪里插数据就往哪里插数据,想删哪数据就删哪数据...。但给线性表一些限制呢,就没那么自由了,把线性表的三边封起来就变成了栈,栈只能...

白客C
今天
42
0
Mybatis Plus service

/** * @author beth * @data 2019-10-20 23:34 */@RunWith(SpringRunner.class)@SpringBootTestpublic class ServiceTest { @Autowired private IUserInfoService iUserInfoS......

一个yuanbeth
今天
5
0
php7-internal 7 zval的操作

## 7.7 zval的操作 扩展中经常会用到各种类型的zval,PHP提供了很多宏用于不同类型zval的操作,尽管我们也可以自己操作zval,但这并不是一个好习惯,因为zval有很多其它用途的标识,如果自己...

冻结not
昨天
6
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部