Swagger Annotation对象

Question

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

Answer 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

Swagger注释提供了与

对象的许多(但不是全部)顶级属性相对应的属性，允许您为自动生成的定义设置这些属性。注释可以在Swagger自动配置过程中扫描的任何类上，也就是说，它不必在JAX-RS类上，而可以只在标记/配置接口

上