poem_openapi

Derive Macro Tags

Source
#[derive(Tags)]
{
    // Attributes available to this derive:
    #[oai]
}
Expand description

Define an OpenAPI Tags.

§Macro parameters

AttributeDescriptionTypeOptional
rename_allRename all the items according to the given case convention. The possible values are “lowercase”, “UPPERCASE”, “PascalCase”, “camelCase”, “snake_case”, “SCREAMING_SNAKE_CASE”, “kebab-case”, “SCREAMING-KEBAB-CASE”.stringY

§Item parameters

AttributeDescriptionTypeOptional
renameRename the tag namestringY
external_docsSpecify a external resource for extended documentationstringY

§Examples

use poem_openapi::Tags;

#[derive(Tags)]
enum ApiTags {
    /// Operations about user
    User,
    /// Operations about pet
    Pet,
}