Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions fern/products/sdks/capabilities.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,19 @@ layout: overview

</Card>

<Card title="IDE support" icon="fa-duotone fa-lightbulb" href="/learn/sdks/deep-dives/sdk-user-features#ide-support-and-intellisense">
Rich autocomplete and inline documentation in your editor

<p className="text-(color:--grayscale-a11) font-bold mt-2 flex items-center gap-1">
Learn more

<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-black.svg" alt="Arrow right light" className="arrow-right dark:hidden m-0 h-4 w-4" noZoom />

<img src="https://files.buildwithfern.com/fern.docs.buildwithfern.com/learn/2025-09-30T17:39:54.370Z/products/home/pages/images/arrow-right-white.svg" alt="Arrow right light" className="arrow-right hidden dark:block m-0 h-4 w-4" noZoom />
</p>

</Card>

<Card title="Idiomatic method names" icon="fa-duotone fa-code" href="/sdks/deep-dives/customize-method-names">
Fine-tune SDK resources and method names

Expand Down
12 changes: 11 additions & 1 deletion fern/products/sdks/guides/generated-sdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,16 @@ that lists all available API methods organized by resource, including method
signatures with parameter types, usage examples, and request/response structures
for each endpoint.

## IDE support and Intellisense

Fern-generated SDKs include full type definitions that enable rich IDE support. When developers use your SDK in editors like VS Code, they get autocomplete, inline documentation, and type information.

The inline documentation comes from your API definition. During the SDK generation process, Fern embeds your parameter descriptions, return types, and code examples directly in the code as docstrings (Python), JSDoc (TypeScript), Javadoc (Java), etc.

<Frame caption="From Vapi Server SDK (TypeScript)" background="subtle">
<img src="../images/intellisense-example.png" alt="IDE intellisense showing method signature and return type"/>
</Frame>

## Error handling

When the API returns a 4xx or 5xx status code, the SDK throws an error that includes the status code, error message, response body, and raw response object.
Expand All @@ -41,4 +51,4 @@ Your SDK users can configure individual requests using language-specific options
| Custom headers | Send additional headers with any request | TypeScript, Java, and Swift |
| Raw response data | Access response headers alongside parsed data | TypeScript, Python, and Go |
| Query parameters | Add extra query string parameters | TypeScript and Swift |
| Abort signals | Cancel in-flight requests | TypeScript only |
| Abort signals | Cancel in-flight requests | TypeScript only |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading