Derive Macro poem_openapi::Schema

#[derive(Schema)]
{
    // Attributes available to this derive:
    #[oai]
}

Define a OpenAPI schema

Macro parameters

Attribute	description	Type	Optional
name	Object name	string	Y
rename_fields	Rename all the fields according to the given case convention. The possible values are “lowercase”, “UPPERCASE”, “PascalCase”, “camelCase”, “snake_case”, “SCREAMING_SNAKE_CASE”.	string	Y
concretes	Specify how the concrete type of the generic Schema should be implemented.	ConcreteType	Y
deprecation	Schema deprecated	bool	Y

Field parameters

Attribute	description	Type	Optional
skip	Skip this field	bool	Y
name	Field name	string	Y

Examples

use poem_openapi::Schema;
 
/// Pet
#[derive(Schema)]
struct Pet {
    /// The id of this pet.
    id: String,
 
    /// The name of this pet.
    name: String,
}