Skip to content

Commit

Permalink
rename
Browse files Browse the repository at this point in the history
  • Loading branch information
fern-support committed Jan 11, 2025
1 parent 615fb22 commit 6ae056c
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 19 deletions.
11 changes: 8 additions & 3 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ css: ./assets/styles.css
redirects:
- source: /learn/api-definition/fern/api-yml-reference
destination: /learn/api-definition/fern/api-yml/overview
- source: /learn/docs/api-references/api-playground/:slug
destination: /learn/docs/api-references/api-explorer/:slug
- source: /learn/docs/api-references/api-playground
destination: /learn/docs/api-references/api-explorer
- source: /learn/sdks/features/:slug
destination: /learn/sdks/capabilities/:slug
- source: /learn/sdks/package-managers/:slug
Expand Down Expand Up @@ -478,16 +482,17 @@ navigation:
- page: SDK Snippets
icon: fa-regular fa-code
path: ./pages/fern-docs/config/sdk-snippets.mdx
- section: API Playground
path: ./pages/fern-docs/content/api-playground.mdx
- section: API Explorer
slug: api-explorer
path: ./pages/fern-docs/content/api-explorer.mdx
icon: fa-regular fa-play
contents:
- page: Auto-populate API Keys
icon: fa-regular fa-key
path: ./pages/fern-docs/content/autopopulate-api-key.mdx
- page: Advanced Configuration
icon: fa-regular fa-screwdriver-wrench
path: ./pages/fern-docs/content/customize-api-playground.mdx
path: ./pages/fern-docs/content/customize-api-explorer.mdx
- page: Endpoint Errors
icon: fa-regular fa-triangle-exclamation
path: ./pages/fern-docs/config/endpoint-errors.mdx
Expand Down
6 changes: 3 additions & 3 deletions fern/pages/docs/comparison/mintlify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ subtitle: How do Fern and Mintlify differ?
| Auto-Populate API Credentials |||
| Websockets Reference & Playground |||
| Multiple Examples per API Endpoint |||
| Dynamic SDK Examples in API Playground |||
| API Playground as Separate Component |||
| Dynamic SDK Examples in API Explorer |||
| API Explorer as Separate Component |||
| Environment Support (Staging, Production) |||
| Role-Based Access Control (RBAC) |||
| Unlimited Number of Editors |||


**Additional Features in Fern**:
- **API Playground as Separate Component**: Fern's API Playground is a distinct feature, similar to Stripe's, allowing users to interact with the API directly within the documentation.
- **API Explorer as Separate Component**: Fern's API Explorer is a distinct feature, similar to Stripe's, allowing users to interact with the API directly within the documentation.
- **Environment Support**: Supports multiple environments such as staging and production, enabling users to test APIs in different settings.
- **Role-Based Access Control (RBAC)**: Allows restriction of content based on the viewer's role, ensuring appropriate access levels.
- **Unlimited Number of Editors**: Does not limit the number of editors, facilitating collaboration among large teams.
Expand Down
4 changes: 2 additions & 2 deletions fern/pages/docs/comparison/readme.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Fern's docs allow you to completely customize your docs to match your brand's ne
| Direct communication for feature requests |||

### 3. Fern is an all-in-one: SDKs + Docs
When you generate SDKs with Fern, you automatically get the SDK code snippets embedded inside your API Reference. Plus, you get an SDK reference that informs a developer about how to get started. In the API Playground, developers can try the API and see how to make a request using the SDK, allowing them to copy, paste, and go.
When you generate SDKs with Fern, you automatically get the SDK code snippets embedded inside your API Reference. Plus, you get an SDK reference that informs a developer about how to get started. In the API Explorer, developers can try the API and see how to make a request using the SDK, allowing them to copy, paste, and go.

<Frame caption="API Docs with SDK code snippets (generated by Fern)">
<img src="./hume-docs.png" />
</Frame>

If you choose ReadMe, you would have to find a separate vendor for SDK generation and would need to manually maintain code examples using the SDK. You also do not have access to dynamic SDK snippets in the API Playground.
If you choose ReadMe, you would have to find a separate vendor for SDK generation and would need to manually maintain code examples using the SDK. You also do not have access to dynamic SDK snippets in the API Explorer.

### 4. Fern offers full OpenAPI support
Fern is built with first-class support for nested objects and will give developers detailed information about what properties are required vs optional as well. Fern can also support the intuitive display of additional properties.
Expand Down
2 changes: 1 addition & 1 deletion fern/pages/docs/getting-started/docs-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Fern Docs provides versatile documentation to support all your content needs, in
</Card>

<Card
title="Interactive API Playground"
title="Interactive API Explorer"
icon="regular play"
href="/learn/docs/api-references/api-playground"
>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: API Playground
title: API Explorer
subtitle: Reduce "time to 200" by allowing users to make real calls to your API from right within the API Reference.
---

<Tip>This feature is available on the Basic plan and above. [Contact us](https://buildwithfern.com/contact) to get set up.</Tip>

Fern's API Playground allows users to make authenticated requests to your API without ever leaving your documentation.
Fern's API Explorer allows users to make authenticated requests to your API without ever leaving your documentation.

### Auto-populate with examples
Fern will automatically populate the fields of the endpoint with the values set in your API specification.
Expand All @@ -28,6 +28,6 @@ Allow users to test their calls in a sandbox environment or select the environme

### WebSocket Playground

For APIs that support WebSocket connections, the API Playground includes a **WebSocket**-specific Playground. The WebSocket Playground also allows users to establish a connection with the API, and send/receive messages in real-time.
For APIs that support WebSocket connections, the API Explorer includes a **WebSocket**-specific Playground. The WebSocket Playground also allows users to establish a connection with the API, and send/receive messages in real-time.

<div style="position: relative; padding-bottom: 56.2%; height: 0;"><iframe src="https://www.loom.com/embed/be4da30404794e9983c4fe639f78d4c8?sid=73b7aeda-98fa-4531-87ed-1e5909500fe2?hide_owner=true&hide_share=true&hide_title=true&hideEmbedTopBar=true" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
2 changes: 1 addition & 1 deletion fern/pages/fern-docs/content/autopopulate-api-key.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Auto-populate API keys
subtitle: Make integrating with your API frictionless by adding your login flow to the API Playground.
subtitle: Make integrating with your API frictionless by adding your login flow to the API Explorer.
---

<Tip>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: Advanced configuration
description: Configure advanced settings like the server URLs reachable by the API playground and authentication with OAuth.
description: Configure advanced settings like the server URLs reachable by the API Explorer and authentication with OAuth.
---

If you subscribe to Fern's Pro or Enterprise Plans, you can customize your API Playground settings to suit your customers needs.
If you subscribe to Fern's Pro or Enterprise Plans, you can customize your API Explorer settings to suit your customers needs.

All configuration settings are defined in the `docs.yml` file, under API Reference navigation configuration, in a `Playground` object.

### Filtering Server Urls

If you have multiple environments for your API, you can filter the server URLs that are displayed in the API Playground.
If you have multiple environments for your API, you can filter the server URLs that are displayed in the API Explorer.

To filter server URLs, add the `environments` property to the `PlaygroundSettings` object in your `docs.yml`, like so:

Expand All @@ -24,7 +24,7 @@ navigation:
### Enabling OAuth 2.0 Authorization Injection
If you have defined an endpoint that executes OAuth 2.0 Client Credentials Authorization in your API definition, you can enable OAuth 2.0 Authorization Injection in your API Playground.
If you have defined an endpoint that executes OAuth 2.0 Client Credentials Authorization in your API definition, you can enable OAuth 2.0 Authorization Injection in your API Explorer.
More information on enabling OAuth 2.0 Authorization Injection can be found [here](/learn/api-definition/fern/authentication#oauth-client-credentials).
To enable OAuth 2.0 Authorization Injection, simply add the `oauth` feature flag to the `PlaygroundSettings` object in your `docs.yml`, like so:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Example: `mintlify`
The authentication strategy used for all API endpoints.
</ResponseField>
<ResponseField name="name" type="string">
The name of the authentication parameter used in the API playground.
The name of the authentication parameter used in the API Explorer.

If method is `basic`, the format should be `[usernameName]:[passwordName]`
</ResponseField>
Expand All @@ -204,7 +204,7 @@ Example: `mintlify`
</ResponseField>

<ResponseField name="playground" type="Playground">
Configurations for the API playground
Configurations for the API Explorer

<Expandable title="Playground">
<ResponseField name="mode" default="show" type='"show" | "simple" | "hide"'>
Expand Down

0 comments on commit 6ae056c

Please sign in to comment.