Swagger and OpenAPI

Overview: @OpenAPIDefinition #

tagged on any class (usually the @SpringBootApplication class) to provide overview of the application APIs.

• info = info/Info.class
  • contact = info/Contact.class
  • license = info/License.class
• ExternalDocumentation.class
• servers/Server.class
  • servers/Servers.class
  • servers/ServerVariable.class
• tags/Tag.class
  • tags/Tags.class
• security/SecurityRequirement.class
  • security/SecurityRequirements.class

@Operation: #

tags: @Tag externalDocs: @ExternalDocumentation parameters: @Parameter responses: @ApiResponse requestBody: @RequestBody security: @SecurityRequirement servers: @Server extensions: @Extension hidden: @Hidden

MISC #

Hidden.class OpenAPI31.class

StringToClassMapItem.class Webhook.class Webhooks.class

callbacks/Callback.class callbacks/Callbacks.class

enums/Explode.class enums/ParameterIn.class enums/ParameterStyle.class enums/SecuritySchemeIn.class enums/SecuritySchemeType.class

extensions/Extension.class extensions/ExtensionProperty.class extensions/Extensions.class

headers/Header.class

links/Link.class links/LinkParameter.class media/ArraySchema.class media/Content.class media/DependentRequired.class media/DependentRequiredMap.class media/DependentSchema.class media/DependentSchemas.class media/DiscriminatorMapping.class media/Encoding.class media/ExampleObject.class media/PatternProperties.class media/PatternProperty.class media/Schema.class media/Schema.class media/Schema.class media/Schema.class media/Schema.class media/SchemaProperties.class media/SchemaProperty.class

parameters/ValidatedParameter.class responses/ApiResponse.class responses/ApiResponses.class security/OAuthFlow.class security/OAuthFlows.class security/OAuthScope.class

security/SecurityScheme.class security/SecuritySchemes.class