0

我在 swagger-ui 中生成的输出是：

DocumentChangeSet {
deletes (Collection«DocumentKey», optional),
updates (Collection«AbstractDocument», optional)
}
Collection«DocumentKey» {}
Collection«AbstractDocument» {}

有没有办法让它更详细

deletes (Collection«DocumentKey», optional), 并 updates (Collection«AbstractDocument», optional) 全面分解这些部分？

我的案卷如下所示：

    @Bean
public Docket api(){

    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build()
            .genericModelSubstitutes(DeferredResult.class)
            .alternateTypeRules(
                    newRule(typeResolver.resolve(DeferredResult.class,
                            typeResolver.resolve(DeferredResult.class,DocumentChangeSet.class)),
                            DocumentChangeSet.class)
            )
            .pathMapping("/")
            .apiInfo(apiInfo());
}

为了添加更多细节，documentKey 和 abstractDocument 都被注释了。

下面是没有任何注释的 DocumentChangeSet 类。

    public DocumentChangeSet(Collection<? extends AbstractDocument> updates, Collection<DocumentKey> deletes) {
    this.updates = ImmutableSet.copyOf(updates);
    this.deletes = ImmutableSet.copyOf(deletes);
}
@Override
public String toString() {
    return Objects.toStringHelper(this)
            .add("updates", updates.size())
            .add("deletes", deletes.size())
            .toString();
}
public Collection<AbstractDocument> getUpdates() {
    return updates;
}

public Collection<DocumentKey> getDeletes() {
    return deletes;
}
4

1 回答 1

1

swagger 的工作方式是，它扫描您的 REST API 代码以查找注释（这些可能是特定的Swagger 注释或JAX-RS 注释，甚至是Jackson 注释）并从中生成 JSON。

然后swagger.json将其馈送到 Swagger UI 并为您生成漂亮的 UI 页面。

长答案简短，使用注释是必要的。

于 2016-06-24T10:15:18.830 回答