openapi_spec library
openapi_spec, Library for OpenAPI specification parsing and generation
# activate openapi_spec
dart pub global activate openapi_spec
# see usage
openapi_spec --help
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
- 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
- SchemaGeneratorOptions
- Security
- A declaration of which security mechanisms can be used for this operation.
- SecurityScheme
- Text
- Server
- Text
- ServerGeneratorOptions
- ServerVariable
- Text
- 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
- HttpSecurityScheme
- IntegerFormat
- The format of the integer value
- NumberFormat
- The format of the number value
- OpenApiFormat
- SchemaType
- StringFormat
- The format of a string