当前位置: 首页 > 知识库问答 >
问题:

阐明Java Restful服务的文档生成问题

赵征
2023-03-14

我正在尝试为我的JAVA restful webservice项目使用expertion插件来生成REST文档。每当我使用maven build运行POM.xml时。我收到以下警告,但文档根本没有生成..

[警告][文档]未找到飞溅包com.layer.rest.service.interfaces。没有飞溅留档。

任何线索请?

共有1个答案

夏星阑
2023-03-14

发音尝试在 package-info 中使用 JavaDoc.java在 enunciate.xml 中定义的包中,如下所示:

<enunciate label="Foo" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modules>
    <docs title="My Foo API"
        splashPackage="org.foo"  />

基于此配置,enuncicate将查找org.foo.package-info.java。如果找不到,它会显示您收到的警告。

有关更多详细信息,请参阅此处的文档模块文档:https://github.com/stoicflame/enunciate/wiki/Module-Docs

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

  • 我正在尝试使用expertion为我的基于Jersey的REST API重新生成文档。碰到一些绊脚石: 发音似乎不能插入可重复项。在我的文档中,我只得到“元素:(自定义)”。请注意,项目类型是用@XmlRootElement和@JsonRootType注释的。 同样,对于此代码: 我为方法参数(注意:T有一个扩展限制)和返回类型(其中响应是:javax.ws.rs.core.响应)获得了“元素:(

  • 我有一个用java编写的Maven JAX RS项目,使用enuncicate在每次构建时自动生成文档。到目前为止,它运行良好——他为我的项目中的所有RESTendpoint生成api文档。 现在我也用有用的jdoc写了一些util类——但是这些类不是endpoint——所以,expertion不会包括它们。 有没有办法告诉enunicate,他应该用一些额外类的jdoc生成额外的文档?我认为应该

  • 1.1、什么是文档服务 目睹云文档服务(DocumentService)是由目睹云开发的面向文档处理的服务,提供将pdf、doc、ppt等多种格式文档转换成图片的转码功能,同时提供文档存储、在线浏览服务。帮助直播,点播用户丰富自己的媒体内容。 1.2、文档服务功能介绍 类别 功能名称 详细内容 文档上传 多格式文档上传 支持多种格式文档,如'doc', 'docx', 'ppt', 'pptx',

  • https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统,参考

  • easyopen提供一个简单的api文档查看页面,类似于swagger,基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明,也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示: 左边的树形菜单对应文档名称,点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的,需要