Swagger 注释对象答案

【问题标题】：Swagger Annotation ObjectSwagger 注释对象
【发布时间】：2017-08-09 06:07:42
【问题描述】：

当我阅读Swagger Annotations apidocs 时，我只是发现有些注释不是针对类或方法的，就像@Info 和@Contact。例如，@Info 的描述是“Swagger 定义的高级元数据”。它只是一个注释对象吗？如何使用它？

【问题讨论】：

标签： java annotations swagger

【解决方案1】：

如果您想自定义您的 swagger 定义中包含的数据，您可以使用以下方法：

@SwaggerDefinition(
        info = @Info(
                description = "My API",
                version = "V1.2.3",
                title = "The only API you'll ever need to learn about me",
                termsOfService = "share and care",
                contact = @Contact(name = "Sponge-Bob", email = "sponge-bob@swagger.io", url = "http://swagger.io"),
                license = @License(name = "Apache 2.0", url = "http://www.apache.org"),

        consumes = {"application/json" },
        produces = {"application/json" },
        schemes = {SwaggerDefinition.Scheme.HTTP, SwaggerDefinition.Scheme.HTTPS},
        externalDocs = @ExternalDocs(value = "About me", url = "http://about.me/me")
)
public interface MyApiDefinition {}

来源：https://swagger.io/blog/customizing-your-auto-generated-swagger-definitions-in-1-5-x/

来自Wiki：

SwaggerDefinition 注解提供了对应的属性 Swagger 对象的许多（但不是全部）顶级属性，允许您为自动生成的定义设置这些。这注释可以在 Swagger 期间扫描的任何类上自动配置过程，即它不必在 JAX-RS 上 API 类，但可能只是在标记/配置接口上

【讨论】：