无法在swagger 2.0文档中插入常见错误代码的html链接

时间:2015-09-09 11:10:08

标签: java json jersey swagger swagger-ui


我在我的API文档中使用swagger 2.0。除了可能的错误代码的模型模式定义之外,我需要和html链接引用外部URL(实际上列出了我的API的所有可能错误代码的详细信息)。

我有什么:

enter image description here

虽然我想尝试这样的事情:

enter image description here

,其中包含一个html链接,位于模型架构定义的正下方。

我尝试了什么: 我希望这个链接是'external-docs'注释的结果,当我检查生成的html和json数据时,它们确实包含'external-docs'元素。

但即使将注释@ExternalDocs放在我的实现者类上,我也没有得到任何相应的引用(无论是在swagger UI上还是在swagger json上)。我也尝试通过servlet将swigger配置放在external-doc引用中,但它也不起作用?

注释参考:

@GET <br>
@Path("/v2/hotspots") <br>
@Produces(MediaType.APPLICATION_JSON) <br>
@ExternalDocs(value="Common Error Codes", url = "some url") <br>
@ApiOperation(....)<br>
@ApiResponses(....)<br>
public final Response someMethod( ) <br>

代码参考:

ExternalDocs exterDoc = new ExternalDocs();
exterDoc.setDescription("Common Error Codes");
exterDoc.setUrl("some url");

Swagger swag = new Swagger();
swag.externalDocs(exterDoc);

beanConfig.configure(swag );

虽然成功加载了beanConfig的其他属性,但外部文档不会被反映出来。

版本详细信息:
Swagger 2.0(1.5.3-M1)
泽西岛2.17
Java 7

将这样的html链接包含在swagger文档中的正确方法是什么?我是否因为包含外部文档而做错了什么?

欢迎任何帮助或建议。在此先感谢!!

0 个答案:

没有答案