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

如何将JSON响应体的格式包含在experience生成的文档中?

萧树
2023-03-14

目前,expertion生成REST API文档,但是响应体不包含关于响应的JSON结构的信息。在我的理解中,如果我包含由Jersey序列化/反序列化到JSON的数据实体的类,expertion将能够生成那部分文档。

数据实体在不同的模块中,按照清晰的留档-多模块项目中的建议,将其源打包

...
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-source-plugin</artifactId>
    <version>2.1.2</version>
    <executions>
        <execution>
            <id>attach-sources</id>
            <phase>package</phase>
            <goals>
                <goal>jar</goal>
            </goals>
        </execution>
    </executions>
</plugin>
...

这是我的发音.xml的样子:

<?xml version="1.0"?>
<enunciate label="someapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="http://enunciate.codehaus.org/schemas/enunciate-1.25.xsd">

    <api-import pattern="com.something.business.vo.**"/>
    <api-import pattern="com.something.business.domain.**"/>

    <api-classes>
        <include pattern="com.something.web.ssoApi.rest.*"/>
        <include pattern="com.something.business.vo.**"/>
        <include pattern="com.something.business.domain.**"/>
    </api-classes>

</enunciate>

文档的样子是这样的:

如您所见,响应体仅包含< code >元素:(custom)。

如何使包含JSON结构的响应?

共有1个答案

松钟展
2023-03-14

为了生成“数据模型”部分的文档,应使用@XmlRootElement对实体进行批注。

 类似资料:
  • Spring Boot Actuator的在捕获输入/输出HTTP参数、标头、用户等方面做得很好。我想扩展它以也捕获HTTP响应的主体,这样我就可以全面了解Web层的进出情况。查看,看起来没有一种方法可以配置响应主体捕获。是否有一种“安全”的方法可以捕获响应主体而不会弄乱它发送回的任何字符流?

  • 问题内容: 我目前正在使用在大多数类型和元素上具有/ 的XML模式。当我从此XML模式生成Java Bean时,这些Bean的Javadoc仅包含一些有关类型/元素的允许内容的通用生成信息。 我想在相关位置查看标记的内容(例如,complextType的标记的内容应显示在代表该complexType的类的Javadoc中)。 有什么办法可以做到这一点? 编辑 :此XML Schema将在具有JAX

  • 本文向大家介绍如何在HTML文档中包含Modernizr?,包括了如何在HTML文档中包含Modernizr?的使用技巧和注意事项,需要的朋友参考一下 Modernizr提供了一种检测任何新功能的简便方法,因此您可以采取相应的措施。例如,如果浏览器不支持视频功能,那么您想显示一个简单的页面。 您可以根据功能的可用性创建CSS规则,如果浏览器不支持新功能,这些规则将自动应用于网页。 您可以从Mode

  • 因此,对于你们中的一些人来说,我的问题可能有点愚蠢,但是我正在查询一些必须作为响应返回的数据,然后我必须在我的应用程序的前端使用该数据的一部分来使用AngularJS和nvD3图表来绘制它。要正确设置绘图工具的数据格式,我必须将此数据转换为正确的 json 格式。我找不到直接的方法从返回的响应中提取我需要的数字。我只需要获取我需要的值,并将它们转换为列表,然后解析为json数组。以下是我为此所做的

  • 问题内容: 正如我们所知,中 Elasticsearch 回报。但是,我需要从那些API。 我正在寻找与.Solr提供的功能类似的功能,Solr提供了使用它的功能,我们可以轻松地在中获得响应。 我如何实现此目标? 注意 : 我不希望只是将ElasticSearch集群的所有内容导出为csv格式。 我想要获得响应而不是json。 更新 我一直在尝试使用答案中@Val建议的方法。 以下是内容 以下是内

  • 场景是,我得到了以下JSON响应,例如: 现在我想检查响应是否在“b”节点中包含“ab”。在空手道方面,我不知道该怎么做。 当方法获得状态200且匹配响应==?,则给定路径“url”??