Api Generator downloads statistics

Api开发利器，接口文档自动生成

Features：

• Javadoc-based analysis,no additional annotations. • Supporting field filtering, automatically ignoring the analysis of filtering fields. • Automatically identify classes, generate markdown documents or upload to Yapi. • Support list, set, collection and other data structures, and support nested generic parsing. • Support the parsing of common annotations such as @NotNull and @ResponseBody, and generate Yapi documents based on json5.

Usage：

• Locate the cursor to the method area or class name, right-click Generate Api.

Support annotations：

javax.validation.constraints.Min

javax.validation.constraints.Max

javax.validation.constraints.NotNull

javax.validation.constraints.NotBlank

javax.validation.constraints.NotEmpty

javax.validation.constraints.Size

org.hibernate.validator.constraints.Length

org.hibernate.validator.constraints.Range

org.springframework.web.bind.annotation.Controller

org.springframework.web.bind.annotation.RestController

org.springframework.web.bind.annotation.RequestMapping

org.springframework.web.bind.annotation.GetMapping

org.springframework.web.bind.annotation.PutMapping

org.springframework.web.bind.annotation.DeleteMapping

org.springframework.web.bind.annotation.PatchMapping

org.springframework.web.bind.annotation.PathVariable

org.springframework.web.bind.annotation.RequestBody

org.springframework.web.bind.annotation.RequestParam

org.springframework.web.bind.annotation.ResponseBody

特性：

• 基于javadoc解析，无代码入侵 • 支持字段过滤，自动忽略过滤字段的解析 • 自动识别类，生成markdown文档或上传到YApi • 支持List、Set、Collection等数据结构，支持嵌套泛型解析 • 支持@NotNull、@ResponseBody等常用注解的解析，基于json5生成YApi文档

用法：

• 将光标定位到方法区域或者类名，鼠标右键单击"Generate Api".

自定义配置项：

Preferences —> Other Settings —> Api Generator Setting

配置项 含义

Exclude Fields 过滤字段（多个字段以","分隔）

Save Directory markdown文档保存目录（绝对路径）

Indent Style 二级字段缩进前缀

Overwrite exists docs 是否覆盖同名markdown文档

Extract filename from doc comments 是否从javadoc抽取文件名

YApi server url YApi部署服务器地址

Project token 项目token

Default save category 默认保存分类

Classify API automatically 是否自动分类

Compatible IDE versions:

2019.1.4+

GitHub | Issues