Back to Poem

Item parameters

poem-openapi/src/docs/request.md

2.0.0660 B
Original Source

Define an OpenAPI request.

Item parameters

AttributeDescriptionTypeOptional
content_typeSpecify the content type.stringY

Examples

rust
use poem_openapi::{
    payload::{Json, PlainText},
    ApiRequest, Object,
};

#[derive(Object)]
struct Pet {
    id: String,
    name: String,
}

#[derive(ApiRequest)]
enum CreatePet {
    /// This request receives a pet in JSON format(application/json).
    CreateByJSON(Json<Pet>),
    /// This request receives a pet in text format(text/plain).
    CreateByPlainText(PlainText<String>),
}