精灵旅社-ballbet贝博体育

精灵旅社-ballbet贝博体育

smart-doc 是一个 java restful api 文档生成东西,smart标签11-doc 推翻了传统相似 swagger 这种大标签26量选用注解侵入来生成文档的完成办法。 smart-doc 彻底根据接口源码剖析来生成接口文档,彻底做到零注解侵入,你只需要依照java标准注释的写,smart-doc 就能帮你生成一精灵旅社-ballbet贝博体育个简易明晰的 Markdown、Html、AsciiDoc 文档。

假如你现已厌恶了 swagger 等文档东西的很多注解和强侵入污染,那请拥抱 smart-doc吧!喜爱 smart-doc 的用户也不要忘掉给项目 star,你们的支撑是 smart-doc 继续推动的动力。

功用特性

  • 零注解、零标签7学习本钱、只需要精灵旅社-ballbet贝博体育写标准java注释。
  • 根据源代码接口界说主动推导,强壮的回来结构推导。
  • 支撑 Spring MVC、Spring Boot、Spring Boot Web Flux(controller 书写方法)。
  • 支撑 Callable、Fut精灵旅社-ballbet贝博体育ure、C标签6ompletableFuture 等异步接口回来的推导。
  • 支撑 JavaBean 上的 JSR精灵旅社-ballbet贝博体育303 参数校验标准。
  • 对 js标签4on 恳求参数的接口能够主动生成模仿 json 参数精灵旅社-ballbet贝博体育。
  • 对一些常用字段界说能够生成有用的模仿值。
  • 支撑生成 json 回来值示例。
  • 支撑从项目外部加载源代码来生成字段注释(包含标准标准发布的标签14 jar 包)。
  • 支精灵旅社-ballbet贝博体育持生成多种格局文档:Markdown、HTML5、Asciidoctor。
  • 容易完成在 Spring Bo标签1ot 服务上在线检查静态 HTML5 api 文档。
  • 敞开文档数据,可自在完成接入文档办理体系。
  • 一款代码注释检测东西,不写注释的小伙伴逃不过高眼了。
  • 支撑导出过错码和界说在代码中的各种枚举字典到接口文档。

Smart-doc vs Swagger

  • smart-doc 不是对 Swagger 造轮子,这是一款用彻底不同的理念从头开发的 restful api 接口文档生成东西。
  • smart-doc 比 swagger 集成更简略,能够自在生成多种格局的 api 文档。
  • smart-doc 彻底不需要在侵精灵旅社-ballbet贝博体育入到事务代码中写任何注解,杂乱嵌套目标主动推导出界说字段结构。
  • smart-doc 代码量很少,假如不能满意你的需求彻底能够自己修正源码。

更新内容

  • fix #I14PT5 header 标签25重复烘托到文档
  • fix #I14MV7 不设置 dataDictionaries 呈现空指针过错标签22
  • 添加恳求参数枚举字段解析(试用功用)

晋级主张

这个一个跟进用户提交的 issues 修正的版别,主张晋级到最新版别防止一些 bug

DEMO

运用 demo 轻松玩转接口文档生成 demo地址:https://github.com/shalousun/api-doc-test

文章转载自 OSCHINA 社区 [http://www.oschina.net]

本文标题:smart-doc 1.7.6 发布,Java 零注解文档生成东西

本文地址:https://www.oschina.net/news/111321/smart-doc-1-7-6-released