vaden_openapi library
Classes
- ApiCallback
- Text
- ClientGeneratorOptions
- Components
- Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. https://swagger.io/specification/#components-object
- Contact
- Text
- Discriminator
- Text
- Encoding
- Text
- Example
- Text
- ExampleObject
- ExternalDocs
- Allows referencing an external resource for extended documentation. https://swagger.io/specification/#external-documentation-object
- Header
- Text
- Info
- Text
- License
- Text
- Link
- The Link object represents a possible design-time link for a response
- MediaType
- Text
- OAuthFlow
- OAuthFlows
- OpenApi
- The OpenAPI Specification (OAS) defines a standard,language-agnostic interface to RESTful APIs
- OpenId
- Open ID protocol configuration
- Operation
- Describes a single API operation on a Path.
- Parameter
- Text
- ParameterCookie
- ParameterHeader
- ParameterPath
- ParameterQuery
- PathItem
- Describes the operations available on a single Path.
- RequestBody
- Text
- Response
- A container for the expected responses of an operation.
- Schema
- The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays
- SchemaArray
- SchemaBoolean
- SchemaEnum
- SchemaGeneratorOptions
- SchemaInteger
- SchemaMap
- SchemaNumber
- SchemaObject
- SchemaString
- Security
- A declaration of which security mechanisms can be used for this operation.
- SecurityScheme
- Text
- Server
- Text
- ServerGeneratorOptions
- ServerVariable
- Text
- SwaggerUI
-
This class starts all the default attributes to start swagger-ui.
In addition to receiving the Spec (YAML/JSON)
it is also possible to configure the title and enable "deepLink".
fileSchemaPath: Schema path (YAML/JSON).
title: Defines the title that is visible in the browser tab.
docExpansion: (Default DocExpansion.list), Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing).
deepLink: (Default true) enables the use of deep-links to reference each node in the url (ex: /swagger/#/post).
syntaxHighlightTheme: (Default SyntaxHighlightTheme.agate) Highlight.js syntax coloring theme to use. (Only these 6 styles are available).
persistAuthorization: (Default false) If set to true, it persists authorization data and it would not be lost on browser close/refresh.
Example: - Tag
- Adds metadata to a single tag that is used by the Operation object. It is not mandatory to have a Tag object per tag defined in the Operation object instances.
- Xml
- Text
Enums
- ApiKeyLocation
- DocExpansion
- Controls the default expansion setting for the operations and tags.
- HttpSecurityScheme
- IntegerFormat
- The format of the integer value
- NumberFormat
- The format of the number value
- OpenApiFormat
- SchemaType
- SpecType
- Type of schema (YAML/JSON).
- StringFormat
- The format of a string
- SyntaxHighlightTheme
- Highlight.js syntax coloring theme to use. (Only these 6 styles are available).