gpt4 book ai didi

maven - 如何在 Enunciate 生成的文档中包含 JSON 响应正文的格式?

转载 作者:行者123 更新时间:2023-12-02 19:38:58 25 4
gpt4 key购买 nike

当前 Enunciate 生成 REST API 文档,但响应正文不包含有关响应的 JSON 结构的信息。根据我的理解,如果我将由 Jersey 序列化/反序列化为 JSON 的数据实体包含在类中,则 enunciate 将能够生成该文档片段。

数据实体位于不同的模块中,该模块按照阐明文档中的建议与其源一起打包 - Multi-Module Projects

...
<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>
...

这就是我的 enunciate.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>

文档如下所示:

Documentation Screenshot

如您所见,响应正文仅包含元素:(自定义)

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

最佳答案

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

关于maven - 如何在 Enunciate 生成的文档中包含 JSON 响应正文的格式?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11097126/

25 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com