@@ -3,6 +3,89 @@ title: PHP Quickstart
33description : Get started quickly with the Fern PHP SDK.
44---
55
6- # PHP Quickstart
6+ < Markdown src = " /products/sdks/snippets/demo-warning.mdx " />
77
8- Follow these steps to quickly get up and running with the Fern PHP SDK.
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