feat(Markdown): display Response Parameters in JSON

Author: jaychang99

src/utils/format-single-api-endpoint-as-markdown.ts

@@ -1,4 +1,5 @@
-import { CustomPathDiffItem } from '../utils/generate-markdown-diff'
+import { CustomPathDiffItem } from './generate-markdown-diff'
+import { jsonToMarkdown } from './json-to-markdown'
 
 type FormatSingleApiEndpointAsMarkdown = (
   endpoint: CustomPathDiffItem
@@ -23,6 +24,14 @@ const symbolByMethod: Record<CustomPathDiffItem['method'], string> = {
 export const formatSingleApiEndpointAsMarkdown: FormatSingleApiEndpointAsMarkdown =
   endpoint => {
     const { url, method, endpointDetailData } = endpoint
+    const { responses } = endpointDetailData
+    const successResponse = responses['200'] ?? responses['201']
+    const successResponseContent = isReferenceObject(successResponse)
+      ? {}
+      : successResponse?.content?.['application/json'] ??
+        successResponse?.content?.['text/plain']
+
+    const responseMarkdown = jsonToMarkdown(successResponseContent)
 
     const parameterMarkdownArray = Object.entries(
       endpointDetailData.parameters ?? {}
@@ -53,6 +62,11 @@ ${parameterMarkdownArray.join('\n')}
 `
     : ''
 }
+
+### Response Parameters
+
+${responseMarkdown}
+
 `
 
     console.log(generatedMarkdown)

src/utils/json-to-markdown.ts

@@ -0,0 +1,25 @@
+// Utility function to format JSON as Markdown code block
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function jsonToMarkdown(obj: any, depth = 0): string {
+  let md = depth === 0 ? '```markdown\n' : '' // Start code block only at the top level
+  const indent = '  '.repeat(depth)
+
+  for (const key in obj) {
+    if (
+      typeof obj[key] === 'object' &&
+      obj[key] !== null &&
+      !Array.isArray(obj[key])
+    ) {
+      md += `${indent} ${key} :\n`
+      md += jsonToMarkdown(obj[key], depth + 1) // Recursively append sub-objects
+    } else {
+      md += `${indent}- ${key}: ${JSON.stringify(obj[key], null, 2)}\n`
+    }
+  }
+
+  if (depth === 0) {
+    md += '```\n' // End code block only at the top level
+  }
+  return md
+}