JApiDocs

Java 的 Api 文档生成工具
授权协议 Apache
开发语言 Java
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 傅正阳
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

简介

JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具。最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以了。

一个简单的示例

特性

  1. 以一个 Controller 作为一组接口导出到一个 Html 文件中。

  2. 支持生成 Java 和 Object-C 语言的 Response 模型代码。

  3. 深度支持 Spring Boot, PlayFrameworkJFinal,不需要额外声明路由。

  4. 支持一般的 Java Web 工程,需要在相关方法添加额外的路由。

  5. 支持接口声明过时(@Deprecated),方便的文档目录等。

  6. 支持自定义代码生成模板。

  • git地址 可以基于 Controller 上的 Java 注释,直接生成接口文档 <dependency> <groupId>io.github.yedaxia</groupId> <artifactId>japidocs</artifactId> <version>1.4.4</version> </dependency> public class TestJApiD

  • 入门 支持JDK:1.8+ 快速开始 第一步:添加依赖 maven: io.github.yedaxia japidocs 1.4.3 gradle: compile 'io.github.yedaxia:japidocs:1.4.3' 第二步:配置参数 你可以在任意一个main入口运行下面的代码: DocsConfig config = new DocsConfig(); config.setP

  • 第一步:添加依赖 maven: <dependency> <groupId>io.github.yedaxia</groupId> <artifactId>japidocs</artifactId> <version>1.4.2</version> </dependency> 第二步:配置参数 你可以在任意一个main入口运行下面的代码: DocsConfig con

  • 1、介绍 JApiDocs 是一个符合 Java 编程习惯的 Api 文档生成工具。最大程度地利用 Java 的语法特性,你只管用心设计好接口,添加必要的注释,JApiDocs 会帮你导出一份漂亮的 Html 文档,并生成相关的 Java 和 Object-C 相关数据模型代码,从此,Android 和 IOS 的同学可以少敲很多代码了,你也不需要费力维护接口文档的变化,只需要维护好你的代码就可以

  • ### [第一步:添加依赖] maven: ~~~ io.github.yedaxia japidocs 1.3 ~~~ gradle: ~~~ compile 'io.github.yedaxia:japidocs:1.3' ~~~ ### [第二步:配置参数] 你可以在任意一个main入口运行下面的代码: ~~~ DocsConfig config = new DocsConfig(); co

  • 在JApiDocs  的1.4.4的版本中,用命令行执行 java -jar japidocs-1.4.4.jar 会抛出异常信息 Exception in thread "main" io.github.yedaxia.apidocs.exception.ConfigException: api version cannot be null at io.github.yedaxi

 相关资料
  • 支持在项目中使用 Swagger 注解语法,运行命令,生成 Swagger 文件。 Swagger 是最流行的 API 开发工具,它遵循 OpenAPI Specification(OpenAPI 规范,也简称 OAS)。 Swagger 可以贯穿于整个 API 生态,如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的,和编程语言无关的 API 描述规范。 imi-

  • 问题内容: 我有使用Java的JAX-RS / Jersey开发的REST API。我想为其转换/生成基于Swagger的UI文档。有人可以简单的方式告诉我精确的步骤吗?很抱歉,他们网站上的步骤对我来说并不清楚。 问题答案: 有几种方法可以将swagger-core与您的应用程序集成,但是根据您的描述,我将按照https://github.com/swagger- api/swagger-core

  • 我正致力于将Springfox 2.2.2整合到我的Spring MVC项目中,但是没有像我所说的那样生成API文档。下面是关于我的配置的一些信息。 我已经提供了以下依赖项(以及其他库,如fasterxml、WebJar、正确版本的spring等) Springfox的配置如下: 示例性控制器如下所示: 使用上面的设置,当我执行URL:localserver:8080/myapp/swagger-

  • 我使用了Swagger UI来显示我的REST Web服务,并将其托管在服务器上。 然而,这种招摇过市的服务只能在特定的服务器上访问。如果我想脱机工作,有人知道我如何使用Swagger UI创建静态PDF并使用它吗?此外,PDF很容易与无权访问服务器的人共享。 非常感谢!

  • 本文向大家介绍SpringBoot+Swagger-ui自动生成API文档,包括了SpringBoot+Swagger-ui自动生成API文档的使用技巧和注意事项,需要的朋友参考一下 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染、先后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远。 这样后段开发好了api 之后就要提交api 文档给前端的朋友。给前端的a

  • 我有一个Spring启动的MVC java网络应用程序。我已经能够为API留档集成Springfox。当服务器启动并运行时,我可以直观地看到所有的API。 我如何生成离线的swagger API文档?注意:我不想使用AsciDoc或markdown文档,但我希望在html文件中使用相同的swagger API用户界面。我希望链接是相对于本地目录的,而不是相对于本地主机服务器链接的。谢谢

  • 我正试图集成Enunicate来生成我们现有的API的REST文档。 我得到一个警告“警告:未知工件‘文档’。不会导出工件。当执行ant任务时。 我的设置中是否缺少什么? .xml的解释是: 相关的蚂蚁片段是: 谢谢。 维努

  • 我使用的是Swashbuckle(5.3.2),它生成了一个很好的API文档。 PetController CarController WebApiConfig null 获取/api/pets post/api/pets 获取/api/pets/{id} carowner_api_key: 汽车 get/api/cars 邮政/API/CARS get/api/cars/{id} null nu