You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/docs/pages/api-references/api-explorer.mdx
+4-2Lines changed: 4 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,10 +5,12 @@ subtitle: Reduce "time to 200" by allowing users to make real calls to your API
5
5
6
6
<Tip>This feature is available on the Basic plan and above. [Contact us](https://buildwithfern.com/contact) to get set up.</Tip>
7
7
8
-
<Warning>This feature is not available in preview mode. Try It buttons will not work when running docs in preview mode (`fern docs dev` or `fern generate --docs --preview`). API explorer requires full docs hosting infrastructure and will only work in published documentation.</Warning>
9
-
10
8
Fern's API Explorer allows users to make authenticated requests to your API without ever leaving your documentation.
11
9
10
+
<Warning>
11
+
The API Explorer (**Try it** button) is not available when [previewing changes locally](/docs/preview-publish/previewing-changes-locally) (`fern docs dev` or `fern generate --docs --preview`) since this feature requires full docs hosting infrastructure.
12
+
</Warning>
13
+
12
14
### Auto-populate with examples
13
15
Fern will automatically populate the fields of the endpoint with the values set in your API specification.
Copy file name to clipboardExpand all lines: fern/products/docs/pages/api-references/sdk-snippets.mdx
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,9 @@ description: Enable SDK code examples in TypeScript, Python, Go, and more from t
5
5
6
6
When you use Fern's SDK Generator, you can automatically display SDK code snippets in your API Reference. These snippets appear in a language selector dropdown, with cURL as the default option.
7
7
8
-
<Note> Fern supports SDK snippets for TypeScript, Python, Ruby, Go, and .NET/C#. </Note>
8
+
These snippets are generated from your API definition examples. Alternatively, dynamic snippets allow users to modify parameters and see code examples update in real time. To enable dynamic snippets, complete the setup instructions on this page and then [contact us](https://buildwithfern.com/contact).
9
9
10
-
<Warning>
11
-
The snippets dropdown for different SDKs will not be available when you are running your docs in [preview mode](/learn/docs/preview-mode) (`fern docs dev` or `fern generate --docs --preview`). This is the expected behavior since these features require our full docs hosting infrastructure. Reach out to us if you'd like to enable dynamic snippets for more languages, so these snippets work during local development.
12
-
</Warning>
10
+
<Note>Fern supports SDK snippets for TypeScript, Python, Ruby, Go, and .NET/C#. [Contact us](https://buildwithfern.com/contact) if you need support for more languages. </Note>
As the final step, trigger your docs generation by running `fern generate --docs` locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a drop-down!
115
+
As the final step, trigger your docs generation by running `fern generate --docs` locally or in CI/CD (i.e., GitHub Actions). The SDK snippets will now appear via a dropdown!
116
+
117
+
<Warning>
118
+
The snippets dropdown is not available when [previewing changes locally](/docs/preview-publish/previewing-changes-locally) (`fern docs dev` or `fern generate --docs --preview`) since this feature requires full docs hosting infrastructure. Dynamic snippets are available in preview mode.
Copy file name to clipboardExpand all lines: fern/products/docs/pages/getting-started/preview-changes-locally.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,12 +37,12 @@ fern docs dev
37
37
A local preview of your documentation will be available at `http://localhost:3000`. The functionality is available offline if you have run local development mode online at least once.
38
38
39
39
<Note>
40
-
Some features (e.g. search) are disabled in the local development environment, including:
40
+
Some features are disabled in the local development environment, including:
0 commit comments