Skip to content

Commit 462cb0b

Browse files
Kapil GowruKapil Gowru
Kapil Gowru
authored and
Kapil Gowru
committed
feat: merged with main
2 parents 7db2a8c + fbdee72 commit 462cb0b

File tree

12 files changed

+928
-18
lines changed

12 files changed

+928
-18
lines changed

‎fern/assets/changelogs/.DS_Store‎

0 Bytes
Binary file not shown.

‎fern/images/.DS_Store‎

2 KB
Binary file not shown.

‎fern/images/product-switcher/recruiting-flyer-2-final.png‎

3.97 MB
Loading

‎fern/images/product-switcher/recruiting-flyer-2.png‎

3.97 MB
Loading

‎fern/products/sdks/overview/dotnet/quickstart.mdx‎

Lines changed: 87 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,91 @@ title: .NET Quickstart
33
description: Get started quickly with the Fern .NET SDK.
44
---
55

6-
Follow these steps to quickly get up and running with the Fern .NET SDK.
6+
<Markdown src="/products/sdks/snippets/demo-warning.mdx"/>
77

8-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/sdks/guides/generate-your-first-sdk).</Warning>
8+
Generate a C#/.NET SDK by following the instructions on this page.
9+
10+
<Steps>
11+
<Markdown src="/products/sdks/snippets/install-cli.mdx"/>
12+
13+
### Initialize the Fern Folder
14+
15+
You can use either the OpenAPI definition, AsyncAPI definition, or Fern
16+
Definition to generate your SDK.
17+
18+
<AccordionGroup>
19+
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>
20+
21+
<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>
22+
23+
<Accordion title="Option 3: Fern Definition">
24+
25+
<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>
26+
27+
2. Add the config option `outputSourceFiles: true` to
28+
`generators.yml`. This ensures your SDK contains source files in
29+
your preferred SDK language instead of compiled output.
30+
31+
```yaml {11-12}
32+
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
33+
default-group: local
34+
groups:
35+
local:
36+
generators:
37+
- name: fernapi/fern-typescript-node-sdk
38+
output:
39+
location: local-file-system
40+
path: ../sdks/typescript
41+
version: <Markdown src="/snippets/version-number.mdx"/>
42+
config:
43+
outputSourceFiles: true
44+
```
45+
46+
<Note>`fern init` creates a default configuration that includes the
47+
TypeScript Node SDK generator. The `local` group containing this
48+
generator only generates if you run fern generate without specifying a
49+
group, or if you explicitly target it with `fern generate --group
50+
local`. In subsequent steps, you'll add an additional generator for your
51+
preferred SDK language.</Note>
52+
</Accordion>
53+
54+
</AccordionGroup>
55+
56+
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
57+
58+
### Add the SDK generator
59+
60+
Add the C#/.NET SDK generator:
61+
62+
```bash
63+
fern add fern-csharp-sdk --group sdk
64+
```
65+
66+
This command adds the following to `generators.yml`:
67+
68+
```yaml
69+
sdk:
70+
generators:
71+
- name: fernapi/fern-csharp-sdk
72+
version: <Markdown src="/snippets/version-number.mdx"/>
73+
output:
74+
location: local-file-system
75+
path: ../sdks/csharp
76+
```
77+
78+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
79+
80+
```bash
81+
fern/ # created in step 1
82+
sdks/ # created by fern generate --group sdk
83+
├─ csharp
84+
└─ src/
85+
├─ YourOrganizationApi.sln
86+
├─ YourOrganizationApi/
87+
├─ Imdb/ # or the name of your API
88+
└─ Core/
89+
└─ YourOrganizationApi.Test/
90+
├─ Utils/
91+
└─ Core/
92+
```
93+
</Steps>

‎fern/products/sdks/overview/java/quickstart.mdx‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,89 @@ title: Java Quickstart
33
description: Get started quickly with the Fern Java SDK.
44
---
55

6-
Follow these steps to quickly get up and running with the Fern Java SDK.
6+
<Markdown src="/products/sdks/snippets/demo-warning.mdx"/>
77

8-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/sdks/guides/generate-your-first-sdk).</Warning>
8+
Generate a Java SDK by following the instructions on this page.
9+
10+
<Steps>
11+
<Markdown src="/products/sdks/snippets/install-cli.mdx"/>
12+
13+
### Initialize the Fern Folder
14+
15+
You can use either the OpenAPI definition, AsyncAPI definition, or Fern
16+
Definition to generate your SDK.
17+
18+
<AccordionGroup>
19+
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>
20+
21+
<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>
22+
23+
<Accordion title="Option 3: Fern Definition">
24+
25+
<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>
26+
27+
2. Add the config option `outputSourceFiles: true` to
28+
`generators.yml`. This ensures your SDK contains source files in
29+
your preferred SDK language instead of compiled output.
30+
31+
```yaml {11-12}
32+
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
33+
default-group: local
34+
groups:
35+
local:
36+
generators:
37+
- name: fernapi/fern-typescript-node-sdk
38+
output:
39+
location: local-file-system
40+
path: ../sdks/typescript
41+
version: <Markdown src="/snippets/version-number.mdx"/>
42+
config:
43+
outputSourceFiles: true
44+
```
45+
46+
<Note>`fern init` creates a default configuration that includes the
47+
TypeScript Node SDK generator. The `local` group containing this
48+
generator only generates if you run fern generate without specifying a
49+
group, or if you explicitly target it with `fern generate --group
50+
local`. In subsequent steps, you'll add an additional generator for your
51+
preferred SDK language.</Note>
52+
</Accordion>
53+
54+
</AccordionGroup>
55+
56+
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
57+
58+
### Add the SDK generator
59+
60+
Add the Java SDK generator:
61+
62+
```bash
63+
fern add fern-java-sdk --group sdk
64+
```
65+
66+
This command adds the following to `generators.yml`:
67+
68+
```yaml
69+
sdk:
70+
generators:
71+
- name: fernapi/fern-java-sdk
72+
version: <Markdown src="/snippets/version-number.mdx"/>
73+
output:
74+
location: local-file-system
75+
path: ../sdks/java
76+
```
77+
78+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
79+
80+
```bash
81+
fern/ # created in step 1
82+
sdks/ # created by fern generate --group sdk
83+
├─ java
84+
├─ YourOrganizationApiClient.java
85+
├─ core/
86+
└─ resources/
87+
└─ imdb/
88+
├─ errors/
89+
└─ types/
90+
```
91+
</Steps>

‎fern/products/sdks/overview/php/configuration.mdx‎

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,39 @@ title: PHP Configuration
33
description: Configuration options for the Fern PHP SDK.
44
---
55

6-
Discover how to configure the Fern PHP SDK for your project.
6+
You can customize the behavior of the PHP SDK generator in `generators.yml`:
7+
8+
```yaml {7-8}
9+
default-group: local
10+
groups:
11+
local:
12+
generators:
13+
- name: fernapi/fern-python
14+
version: <Markdown src="/snippets/version-number.mdx"/>
15+
config:
16+
clientName: YourClientName
17+
```
18+
19+
## SDK Configuration Options
20+
21+
<ParamField path="clientName" type="string" required={false}>
22+
</ParamField>
23+
24+
<ParamField path="inlinePathParameters" type="boolean" required={false}>
25+
</ParamField>
26+
27+
<ParamField path="packageName" type="string" required={false}>
28+
</ParamField>
29+
30+
<ParamField path="packagePath" type="string" required={false}>
31+
</ParamField>
32+
33+
<ParamField path="propertyAccess" type="'public' | 'private'" required={false}>
34+
</ParamField>
35+
36+
<ParamField path="namespace" type="string" required={false}>
37+
</ParamField>
38+
39+
<ParamField path="composerJson" type="Record<string, any>" required={false}>
40+
</ParamField>
741
8-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/sdks/reference/configuration).</Warning>

‎fern/products/sdks/overview/php/quickstart.mdx‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,89 @@ title: PHP Quickstart
33
description: Get started quickly with the Fern PHP SDK.
44
---
55

6-
Follow these steps to quickly get up and running with the Fern PHP SDK.
6+
<Markdown src="/products/sdks/snippets/demo-warning.mdx"/>
77

8-
<Warning>This page is a WIP, please refer to our previous [documentation](https://buildwithfern.com/learn/sdks/guides/generate-your-first-sdk).</Warning>
8+
Generate a PHP SDK by following the instructions on this page.
9+
10+
<Steps>
11+
<Markdown src="/products/sdks/snippets/install-cli.mdx"/>
12+
13+
### Initialize the Fern Folder
14+
15+
You can use either the OpenAPI definition, AsyncAPI definition, or Fern
16+
Definition to generate your SDK.
17+
18+
<AccordionGroup>
19+
<Markdown src="/products/sdks/snippets/option-1-openapi.mdx"/>
20+
21+
<Markdown src="/products/sdks/snippets/option-2-asyncapi.mdx"/>
22+
23+
<Accordion title="Option 3: Fern Definition">
24+
25+
<Markdown src="/products/sdks/snippets/option-3-fern-def.mdx"/>
26+
27+
2. Add the config option `outputSourceFiles: true` to
28+
`generators.yml`. This ensures your SDK contains source files in
29+
your preferred SDK language instead of compiled output.
30+
31+
```yaml {11-12}
32+
# yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json
33+
default-group: local
34+
groups:
35+
local:
36+
generators:
37+
- name: fernapi/fern-typescript-node-sdk
38+
output:
39+
location: local-file-system
40+
path: ../sdks/typescript
41+
version: <Markdown src="/snippets/version-number.mdx"/>
42+
config:
43+
outputSourceFiles: true
44+
```
45+
46+
<Note>`fern init` creates a default configuration that includes the
47+
TypeScript Node SDK generator. The `local` group containing this
48+
generator only generates if you run fern generate without specifying a
49+
group, or if you explicitly target it with `fern generate --group
50+
local`. In subsequent steps, you'll add an additional generator for your
51+
preferred SDK language.</Note>
52+
</Accordion>
53+
54+
</AccordionGroup>
55+
56+
<Markdown src="/products/sdks/snippets/pass-fern-check.mdx"/>
57+
58+
### Add the SDK generator
59+
60+
Add the PHP SDK generator:
61+
62+
```bash
63+
fern add fern-php-sdk --group sdk
64+
```
65+
66+
This command adds the following to `generators.yml`:
67+
68+
```yaml
69+
sdk:
70+
generators:
71+
- name: fernapi/fern-php-sdk
72+
version: <Markdown src="/snippets/version-number.mdx"/>
73+
output:
74+
location: local-file-system
75+
path: ../sdks/php/sdk
76+
```
77+
78+
<Markdown src="/products/sdks/snippets/generate-sdk.mdx"/>
79+
80+
```bash
81+
fern/ # created in step 1
82+
sdks/ # created by fern generate --group sdk
83+
├─ php
84+
└─ sdk/
85+
├─ src/
86+
├─ YourOrganizationClient.php
87+
└─ Imdb/ # or the name of your API
88+
└─ tests/
89+
└─ Core/
90+
```
91+
</Steps>

0 commit comments

Comments
 (0)