当前位置: 首页 > 软件库 > Web应用开发 > SPDY开发包 >

API-doc

RESTful API 文档生成工具
授权协议 Apache
开发语言 Java
所属分类 Web应用开发、 SPDY开发包
软件类型 开源软件
地区 国产
投 递 者 阎晔
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

RESTful API 标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发者查阅。

1. 遵循OpenAPI规范编写RESTful API的接口定义

2. 生成直观的HTML和PDF格式的文档

3. 对中文的完美支持,解决asciidoctor生成中文时的乱码问题

HTML格式的文档截图:

PDF格式文档截图:

 

  • swagger :/v2/api-docs中找不到HTTP 404 swagger :/v2/api-docs中找不到HTTP 404 描述: 新增一个模块swagger识别不到,其他模块可以用,检查过注解配置之类的没问题,找了半天一一排除,最后发现是实体类java权限字符的问题。 将private误写成public,改回来就可以了,在此做一个记录。

  • Swagger2的/v2/api-docs接口是如何对第三方项目暴露的呢?也就是说jar包中如何暴露接口给第三方应用? 答案是:HandlerMapping swagger2实现了自己的HandlerMapping,在实现类PropertySourcedRequestMappingHandlerMapping中,把/v2/api-docs接口保存到了handlerMethods 集合。然后提供了访

  • 前面已经获取得到了swagger的分组接口信息了,接下来就是根据分组名称获取每个分组的Swagger资源详细信息,在springfox中提供了/v2/api-docs接口来进行获取 来看接口的源码 @Controller @ApiIgnore public class Swagger2Controller { public static final String DEFAULT_URL =

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

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

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

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

  • 本文向大家介绍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