Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support multiple content types #26

Merged
merged 7 commits into from
Nov 5, 2024
Merged

Support multiple content types #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dce19ce
Support XML::Value with the right content header
afsalthaj Nov 4, 2024
5b7e6ce
Make sure to send yaml as bytes
afsalthaj Nov 4, 2024
e604370
Support all content_types
afsalthaj Nov 4, 2024
70c44d3
Reformat
afsalthaj Nov 4, 2024
eaeb965
Fix checks
afsalthaj Nov 4, 2024
be8adf9
use json if content type is *
afsalthaj Nov 4, 2024
e30d452
Update client_gen
afsalthaj Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
257 changes: 199 additions & 58 deletions src/rust/client_gen.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ use openapiv3::{
OpenAPI, Operation, Parameter, ParameterData, ParameterSchemaOrContent, PathItem, ReferenceOr,
RequestBody, Response, Schema, SchemaKind, StatusCode, Tag, Type,
};
use std::collections::{BTreeMap, HashSet};
use std::collections::{BTreeMap, HashMap, HashSet};

#[derive(Debug, Clone, PartialEq, Eq)]
enum PathElement {
Expand Down Expand Up @@ -186,6 +186,37 @@ struct Param {
kind: ParamKind,
}

#[derive(Debug, Clone)]
pub struct RequestBodyParams {
params: HashMap<ContentType, Vec<Param>>,
}

impl RequestBodyParams {
fn has_single_content_type(&self) -> bool {
self.params.len() == 1
}

fn get_default_request_body_param(&self) -> Option<&Vec<Param>> {
self.params
.values()
.next()
.filter(|_| self.has_single_content_type())
}
}

#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub struct ContentType(pub String);

impl ContentType {
pub fn is_json(&self) -> bool {
self.0 == "application/json"
}

pub fn is_yaml(&self) -> bool {
self.0 == "application/x-yaml"
}
}

impl Param {
fn render_declaration(&self) -> RustPrinter {
let type_name = self.tpe.render_declaration(true);
Expand Down Expand Up @@ -268,7 +299,7 @@ fn match_tag(tag: &Option<Tag>, path_item: &ReferenceOr<PathItem>) -> bool {
fn param_data_to_type(data: &ParameterData, ref_cache: &mut RefCache) -> Result<DataType> {
match &data.format {
ParameterSchemaOrContent::Schema(ref_or_schema) => {
ref_or_schema_type(ref_or_schema, ref_cache)
ref_or_schema_type(ref_or_schema, ref_cache, None)
}
ParameterSchemaOrContent::Content(_) => {
Err(Error::unimplemented("Content parameter is not supported."))
Expand All @@ -295,45 +326,74 @@ fn parameter(p: &ReferenceOr<Parameter>, ref_cache: &mut RefCache) -> Result<Par
fn request_body_params(
body: &ReferenceOr<RequestBody>,
ref_cache: &mut RefCache,
) -> Result<Vec<Param>> {
) -> Result<RequestBodyParams> {
let mut content_type_params = HashMap::new();

match body {
ReferenceOr::Reference { reference } => Err(Error::unimplemented(format!(
"Unexpected ref request body: '{reference}'."
))),
ReferenceOr::Reference { reference } => {
return Err(Error::unimplemented(format!(
"Unexpected ref request body: '{reference}'."
)))
}
ReferenceOr::Item(body) => {
if body.content.len() != 1 {
Err(Error::unimplemented("Content with not exactly 1 option."))
} else {
let (content_type, media_type) = body.content.first().unwrap();

if content_type.starts_with("application/json") {
for (content_type, media_type) in &body.content {
if content_type.starts_with("application/json") || content_type == "*/*" {
let schema = match &media_type.schema {
None => Err(Error::unimplemented("JSON content without schema.")),
Some(schema) => Ok(schema),
};

Ok(vec![Param {
original_name: "".to_string(),
name: "value".to_string(),
tpe: ref_or_schema_type(schema?, ref_cache)?,
required: body.required,
kind: ParamKind::Body,
}])
content_type_params.insert(
ContentType(content_type.clone()),
vec![Param {
original_name: "".to_string(),
name: "value".to_string(),
tpe: ref_or_schema_type(
schema?,
ref_cache,
Some(content_type.clone()),
)?,
required: body.required,
kind: ParamKind::Body,
}],
);
} else if content_type == "application/octet-stream" {
Ok(vec![Param {
content_type_params.insert(
ContentType(content_type.clone()),
vec![Param {
original_name: "".to_string(),
name: "value".to_string(),
tpe: DataType::Binary,
required: body.required,
kind: ParamKind::Body,
}],
);
} else if content_type.contains("application/x-yaml") {
let schema = match &media_type.schema {
None => Err(Error::unimplemented("YAML content without schema.")),
Some(schema) => Ok(schema),
};

let param = Param {
original_name: "".to_string(),
name: "value".to_string(),
tpe: DataType::Binary,
tpe: ref_or_schema_type(schema?, ref_cache, Some(content_type.clone()))?,
required: body.required,
kind: ParamKind::Body,
}])
};

content_type_params.insert(ContentType(content_type.clone()), vec![param]);
} else if content_type == "multipart/form-data" {
match &media_type.schema {
None => Err(Error::unimplemented("Multipart content without schema.")),
None => {
return Err(Error::unimplemented("Multipart content without schema."))
}
Some(schema) => match schema {
ReferenceOr::Reference { reference } => Err(Error::unimplemented(
format!("Unexpected ref multipart schema: '{reference}'."),
)),
ReferenceOr::Reference { reference } => {
return Err(Error::unimplemented(format!(
"Unexpected ref multipart schema: '{reference}'."
)))
}
ReferenceOr::Item(schema) => match &schema.schema_kind {
SchemaKind::Type(Type::Object(obj)) => {
fn multipart_param(
Expand All @@ -351,7 +411,8 @@ fn request_body_params(
})
}

obj.properties
let params = obj
.properties
.iter()
.map(|(name, schema)| {
multipart_param(
Expand All @@ -361,41 +422,39 @@ fn request_body_params(
ref_cache,
)
})
.collect()
.collect::<Result<Vec<_>>>()?;

content_type_params
.insert(ContentType(content_type.clone()), params);
}
_ => {
return Err(Error::unimplemented(
"Object schema expected for multipart request body.",
))
}
_ => Err(Error::unimplemented(
"Object schema expected for multipart request body.",
)),
},
},
}
} else {
Err(Error::unimplemented(format!(
return Err(Error::unimplemented(format!(
"Request body content type: '{content_type}'."
)))
)));
}
}
}
}

Ok(RequestBodyParams {
params: content_type_params,
})
}

fn parameters(op: &PathOperation, ref_cache: &mut RefCache) -> Result<Vec<Param>> {
let params: Result<Vec<Param>> = op
.op
op.op
.parameters
.iter()
.map(|p| parameter(p, ref_cache))
.collect();

let mut params = params?;

if let Some(body) = &op.op.request_body {
for p in request_body_params(body, ref_cache)? {
params.push(p);
}
}

Ok(params)
.collect()
}

fn as_code(code: &StatusCode) -> Option<u16> {
Expand Down Expand Up @@ -449,7 +508,11 @@ fn response_type(response: &ReferenceOr<Response>, ref_cache: &mut RefCache) ->
Some(schema) => Ok(schema),
};

Ok(ref_or_schema_type(schema?, ref_cache)?)
Ok(ref_or_schema_type(
schema?,
ref_cache,
Some(content_type.clone()),
)?)
} else if content_type == "application/octet-stream" {
Ok(DataType::Binary)
} else {
Expand Down Expand Up @@ -494,40 +557,107 @@ fn method_errors(
Ok(MethodErrors { codes: codes? })
}

fn trait_method(
fn trait_methods_specific_to_content_type(
op: &PathOperation,
prefix_length: usize,
ref_cache: &mut RefCache,
) -> Result<Method> {
) -> Result<Vec<Method>> {
let (result_code, result_type) = method_result(&op.op.responses.responses, ref_cache)?;

let name = if let Some(op_id) = &op.op.operation_id {
op_id.to_case(Case::Snake)
let name = op
.op
.operation_id
.as_ref()
.map(|op_id| op_id.to_case(Case::Snake))
.unwrap_or_else(|| op.path.strip_prefix(prefix_length).method_name(&op.method));

let mut main_params = parameters(op, ref_cache)?;

if let Some(body) = &op.op.request_body {
let content_specific = request_body_params(body, ref_cache)?;

if let Some(request_body_params) = content_specific.get_default_request_body_param() {
main_params.extend(request_body_params.iter().cloned());
return Ok(vec![create_method(
name,
op,
&main_params,
result_type,
result_code,
ref_cache,
)?]);
}

let mut methods = Vec::new();
for (content_type, params) in content_specific.params {
let method_name = match_content_type(content_type, &name)?;
let new_params = [main_params.clone(), params].concat();
methods.push(create_method(
method_name,
op,
&new_params,
result_type.clone(),
result_code.clone(),
ref_cache,
)?);
}

Ok(methods)
} else {
op.path.strip_prefix(prefix_length).method_name(&op.method)
};
Ok(vec![create_method(
name,
op,
&main_params,
result_type,
result_code,
ref_cache,
)?])
}
}

fn create_method(
name: String,
op: &PathOperation,
params: &[Param],
result_type: DataType,
result_code: StatusCode,
ref_cache: &mut RefCache,
) -> Result<Method> {
Ok(Method {
name,
path: op.path.clone(),
original_path: op.original_path.clone(),
http_method: op.method.to_string(),
params: parameters(op, ref_cache)?,
params: params.to_vec(),
result: result_type,
result_status_code: result_code.clone(),
errors: method_errors(&op.op.responses.responses, result_code, ref_cache)?,
})
}

fn match_content_type(content_type: ContentType, base_name: &str) -> Result<String> {
if content_type.is_json() {
Ok(format!("{}_json", base_name))
} else if content_type.is_yaml() {
Ok(format!("{}_yaml", base_name))
} else {
Err(Error::unimplemented(
"Multiple content types supported only for JSON and YAML",
))
}
}

fn trait_methods(
operations: &[PathOperation],
prefix_length: usize,
ref_cache: &mut RefCache,
) -> Result<Vec<Method>> {
operations
let res = operations
.iter()
.map(|op| trait_method(op, prefix_length, ref_cache))
.collect()
.map(|op| trait_methods_specific_to_content_type(op, prefix_length, ref_cache))
.collect::<Result<Vec<Vec<_>>>>()?;

Ok(res.into_iter().flatten().collect())
}

fn render_errors(method_name: &str, error_kind: &ErrorKind, errors: &MethodErrors) -> RustResult {
Expand Down Expand Up @@ -837,7 +967,18 @@ fn render_method_implementation(method: &Method, error_kind: &ErrorKind) -> Rust
r#"request = request.header(reqwest::header::CONTENT_TYPE, "application/octet-stream");"#,
)
+ NewLine
} else {
} else if param.tpe == DataType::Yaml {
line(
unit()
+ "request = request.body(serde_yaml::to_string("
+ &param.name
+ ").unwrap_or_default().into_bytes());",
) + line(
r#"request = request.header(reqwest::header::CONTENT_TYPE, "application/x-yaml");"#,
) + NewLine
}
// Not sure why everything else is assumed to be json (previously)
else {
line(unit() + "request = request.json(" + &param.name + ");") + NewLine
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/rust/lib_gen.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,11 @@ mod tests {
"lib",
&[
ModuleDef {
name: ModuleName::new("abc".to_string()),
name: ModuleName::new("abc"),
exports: vec!["C".to_string(), "B".to_string()],
},
ModuleDef {
name: ModuleName::new("xyz".to_string()),
name: ModuleName::new("xyz"),
exports: vec!["A".to_string(), "Y".to_string()],
},
],
Expand Down
Loading
Loading