Skip to content

Fix Python code sample JSON body #2976

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

Closed
rodrcastro wants to merge 3 commits into from
+16 −4
Closed

Fix Python code sample JSON body #2976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b271dd
change code sample in python
rodrcastro Mar 12, 2025
0bef455
fix tests
rodrcastro Mar 12, 2025
631cecc
Better support for python json
nolannbiron Mar 19, 2025
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
4 changes: 2 additions & 2 deletions packages/react-openapi/src/code-samples.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ describe('python code sample generator', () => {
const output = generator?.generate(input);

expect(output).toBe(
'import requests\n\nresponse = requests.get(\n "https://example.com/path",\n headers={"Content-Type":"application/json"},\n data={"key":"value"}\n)\n\ndata = response.json()'
'import requests\n\nresponse = requests.get(\n "https://example.com/path",\n headers={"Content-Type":"application/json"},\n json={"key":"value"}\n)\n\ndata = response.json()'
);
});

Expand Down Expand Up @@ -419,7 +419,7 @@ describe('python code sample generator', () => {
const output = generator?.generate(input);

expect(output).toBe(
'import requests\n\nresponse = requests.get(\n "https://example.com/path",\n headers={"Content-Type":"application/graphql"},\n data="{ key }"\n)\n\ndata = response.json()'
'import requests\n\nresponse = requests.get(\n "https://example.com/path",\n headers={"Content-Type":"application/json"},\n json="{ key }"\n)\n\ndata = response.json()'
);
});

Expand Down
16 changes: 14 additions & 2 deletions packages/react-openapi/src/code-samples.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,14 @@ export const codeSampleGenerators: CodeSampleGenerator[] = [
code += indent(`headers=${stringifyOpenAPI(headers)},\n`, 4);
}

const contentType = headers?.['Content-Type'] || '';

if (body) {
if (body === 'files') {
code += indent(`files=${body}\n`, 4);
} else if (contentType === 'application/json') {
// If the content type is JSON, we use json={}
code += indent(`json=${stringifyOpenAPI(body)}\n`, 4);
} else {
code += indent(`data=${stringifyOpenAPI(body)}\n`, 4);
}
Expand Down Expand Up @@ -326,7 +331,9 @@ const BodyGenerators = {
getPythonBody: (body: any, headers?: Record<string, string>) => {
if (!body || !headers) return;
let code = '';
const contentType: string = headers['Content-Type'] || '';
// Copy headers to avoid mutating the original object
const headersCopy = { ...headers };
const contentType: string = headersCopy['Content-Type'] || '';

if (isFormData(contentType)) {
code += 'files = {\n';
Expand All @@ -346,7 +353,12 @@ const BodyGenerators = {
body = 'files';
}

return { body, code, headers };
if (isGraphQL(contentType)) {
// Set Content-Type to application/json for GraphQL, recommended by GraphQL spec
headersCopy['Content-Type'] = 'application/json';
}

return { body, code, headers: headersCopy };
},
getHTTPBody: (body: any, headers?: Record<string, string>) => {
if (!body || !headers) return undefined;
Expand Down