How to impl this case with aide #249

joebnb · 2025-09-23T13:57:17Z

joebnb
Sep 23, 2025

hello, i have a quest about when handler recive a Result, the api docs seem out put empty(expect string)

a aide apirouter

use super::handler;
use aide::axum::{ApiRouter, routing::*};

pub fn register() -> ApiRouter {
    let test_router = ApiRouter::new()
        .api_route(
            "/session_save",
            get(handler::session_save),
        );
    ApiRouter::new().nest_api_service("/test", test_router)
}

when out put session with string with wrapper HttpResult

pub async fn session_save() -> http::HttpResult<String> {
    http::response_200(Some(format!("{} session saved ", total)), None)
}

http result implment

pub type HttpResult<T> = Result<SResponseBasic<T>, HttpInternalError>;

#[derive(Debug, Clone, JsonSchema)]
pub struct SResponseBasic<T> {
    pub body: Option<T>,
    #[schemars(skip)]
    pub status_code: Option<StatusCode>,
    pub msg: Option<String>,
}
impl<T> IntoResponse for SResponseBasic<T>
where
    T: Serialize + Clone + JsonSchema + Send,
{
    fn into_response(self) -> Response<Body> {
        let status_code = self.status_code.unwrap_or(StatusCode::OK);
        let response_data = SReponseStruct {
            success: status_code == StatusCode::OK,
            data: self.body,
            msg: self.msg.unwrap_or("success".to_string()),
        };
        Json(response_data).into_response()
    }
}
impl<T> OperationOutput for SResponseBasic<T>
where
    T: Serialize + Clone + Send + JsonSchema + 'static,
{
    type Inner = SResponseBasic<T>;
}



#[derive(Serialize, Deserialize, JsonSchema)]
pub struct HttpInternalError(String);
impl IntoResponse for HttpInternalError {
    fn into_response(self) -> Response {
        (StatusCode::INTERNAL_SERVER_ERROR, Json(self.0)).into_response()
    }
}
impl OperationOutput for HttpInternalError {
    type Inner = Infallible;
}

but empty was output

SResponseBasic also implement IntoResponse

AstrickHarren · 2025-10-19T15:48:41Z

AstrickHarren
Oct 19, 2025

I think you need to use get_with instead of get

1 reply

joebnb Nov 1, 2025
Author

if i use get_with it's mean aide is no different like utoipa, type no relation with struct and route, i will try jplatte said method

jplatte · 2025-10-20T17:13:58Z

jplatte
Oct 20, 2025
Collaborator

Your OperationOutput impls are empty, so there is nothing for aide to output. You should fill in at least fn operation_response (looks like it can delegate to <(StatusCode, Json<SReponseStruct>)>::operation_response).

6 replies

jplatte Nov 2, 2025
Collaborator

hi, jplatte , thanks for point this, when i follow your advice i found this may couldn't work because rust orphan rule, the <(StatusCode, Json)> tuple can't implement operation_response.

I didn't say you should implement anything for the tuple. What I said is you can delegate to the existing implementation within yours. That is:

impl<T> OperationOutput for SResponseBasic<T>
where
    T: Serialize + Clone + Send + JsonSchema + 'static,
{
    type Inner = SResponseBasic<T>;

    fn operation_response(
        ctx: &mut GenContext,
        operation: &mut Operation,
    ) -> Option<Response> {
        <(StatusCode, Json<SReponseStruct>)>::operation_response(ctx, operation)
    }

    fn inferred_responses(
        ctx: &mut GenContext,
        operation: &mut Operation,
    ) -> Vec<(Option<u16>, Response)> {
        <(StatusCode, Json<SReponseStruct>)>::inferred_responses(ctx, operation)
    }
}

Make sure to enable aides axum-json Cargo feature for this to work.

joebnb Nov 4, 2025
Author

 <(StatusCode, Json<SReponseStruct>)>::inferred_responses(ctx, operation)

hi,jplatte when i use upper code, it's actually not generate anything, when service start, generate flow seems only calling inferred_responses , not operation_response.

impl<T> OperationOutput for SResponseBasic2<T>
where
    T: Serialize + Clone + Send + JsonSchema + 'static,
{
    type Inner = SReponseStruct2<T>;

    fn operation_response(
        ctx: &mut aide::generate::GenContext,
        operation: &mut aide::openapi::Operation,
    ) -> Option<aide::openapi::Response> {
        println!(
            "Generating OpenAPI response for SReponseStruct2 operation_response {:?}",
            operation
        ); // this line not print in console
        let result = <(StatusCode, Json<SReponseStruct2<T>>)>::operation_response(ctx, operation);
        println!("result operation_response: {:#?}", result);
        result
       
    }

    fn inferred_responses(
        ctx: &mut GenContext,
        operation: &mut aide::openapi::Operation,
    ) -> Vec<(Option<u16>, aide::openapi::Response)> {
        println!("Generating OpenAPI response for SReponseStruct2,inferred_responses");
        let result = <(StatusCode, Json<SReponseStruct2<T>>)>::inferred_responses(ctx, operation);
        println!("result inferred_responses: {:#?}", result);
        
        result
    }
}

the output like:

Generating OpenAPI response for SReponseStruct2,inferred_responses
result inferred_responses: []
Generating OpenAPI response for SReponseStruct2,inferred_responses
result inferred_responses: []
2025-11-04T14:37:51.188000Z  WARN Run app with hyper, listening on: http://0.0.0.0:3000

when i change to

fn inferred_responses(
        ctx: &mut GenContext,
        operation: &mut aide::openapi::Operation,
    ) -> Vec<(Option<u16>, aide::openapi::Response)> {
        println!("Generating OpenAPI response for SReponseStruct2,inferred_responses");
        // let result = <(StatusCode,Json<SReponseStruct2<T>>)>::inferred_responses(ctx, operation);
        // result
        if let Some(res) = Self::operation_response(ctx, operation) {
            let success_response = [(Some(200), res)];
            Vec::from(success_response)
        } else {
            Vec::new()
        }
    }

the operation_response will called
and output:

ENV FILE: ".env.local"
Generating OpenAPI response for SReponseStruct2,inferred_responses
Generating OpenAPI response for SReponseStruct2 operation_response Operation { tags: [], summary: None, description: None, external_docs: None, operation_id: None, parameters: [], request_body: None, responses: None, deprecated: false, security: [], servers: [], callbacks: {}, extensions: {} }
result operation_response: None
Generating OpenAPI response for SReponseStruct2,inferred_responses
Generating OpenAPI response for SReponseStruct2 operation_response Operation { tags: [], summary: None, description: None, external_docs: None, operation_id: None, parameters: [], request_body: None, responses: None, deprecated: false, security: [], servers: [], callbacks: {}, extensions: {} }
result operation_response: None
2025-11-04T14:39:33.851182Z  WARN Run app with hyper, listening on: http://0.0.0.0:3000

i'm not sure is problem caused by using pub use axum::http::StatusCode; not aide StatusCode ?

joebnb Nov 4, 2025
Author

It seems unrelated to status codes, since it literally reads the u16 as a status code. In fact, if I simply fix the issue of the incorrect definition lookup path, my original approach would work — though ideally, letting Aide handle everything would be better for maintainability by the package developers.

jplatte Nov 8, 2025
Collaborator

I'm sorry, I can't really follow half of what you're writing here and I don't have the energy to do much support these days. Still, what I wrote should work (actually the StatusCode bit is useless I guess, but it also wouldn't hurt).

joebnb Dec 27, 2025
Author

Ok... finally i gave up for adding this into axum, it‘s doesn't works for my project, maybe im not following the good practice of axum project, and aide are lake out discussion cases

This comment was marked as spam.

Sign in to view

How to impl this case with aide #249

Uh oh!

Uh oh!

joebnb Sep 23, 2025

Replies: 3 comments · 7 replies

This comment was marked as spam.

Uh oh!

AstrickHarren Oct 19, 2025

Uh oh!

joebnb Nov 1, 2025 Author

Uh oh!

Uh oh!

jplatte Oct 20, 2025 Collaborator

Uh oh!

jplatte Nov 2, 2025 Collaborator

Uh oh!

joebnb Nov 4, 2025 Author

Uh oh!

joebnb Nov 4, 2025 Author

Uh oh!

Uh oh!

jplatte Nov 8, 2025 Collaborator

Uh oh!

joebnb Dec 27, 2025 Author

joebnb
Sep 23, 2025

Replies: 3 comments 7 replies

AstrickHarren
Oct 19, 2025

joebnb Nov 1, 2025
Author

jplatte
Oct 20, 2025
Collaborator

jplatte Nov 2, 2025
Collaborator

joebnb Nov 4, 2025
Author

joebnb Nov 4, 2025
Author

jplatte Nov 8, 2025
Collaborator

joebnb Dec 27, 2025
Author