Skip to content

Commit aa54d46

Browse files
dev portals
1 parent fe5d617 commit aa54d46

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,47 @@ sidebar:
77

88
---
99

10-
import { GlossaryTooltip, Steps } from "~/components"
10+
import { GlossaryTooltip, Tabs, TabItem, Steps } from "~/components"
1111

12-
Once <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved into Endpoint Management, API Shield doubles as an API catalog. API Shield can build an interactive documentation portal with the knowledge it has of your APIs, or you can upload a new OpenAPI schema file to build a documentation portal ad-hoc.
12+
Once your <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved, API Shield doubles as an API catalog. API Shield can build an interactive documentation portal with the knowledge it has of your APIs, or you can upload a new OpenAPI schema file to build a documentation portal ad-hoc.
1313

1414
To create a developer portal:
1515

16-
<Steps>
17-
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
18-
2. Go to **Security** > **API Shield** > **Settings**.
19-
3. Under **Create a developer portal**, select **Create site**.
20-
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
21-
:::note
22-
If you do not have a schema to upload or to select from a pre-existing schema, export your Endpoint Management schema. For best results, include the learned parameters.
23-
24-
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
25-
:::
26-
5. Select **Download project files** to save a local copy of the files that will be uploaded to Cloudflare Pages. Downloading the project files can be helpful if you wish to modify the project in any way and then upload the new version manually to Pages.
27-
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
28-
7. Select **Deploy site**.
29-
</Steps>
16+
<Tabs syncKey="dashNewNav">
17+
<TabItem label="Old dashboard">
18+
<Steps>
19+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
20+
2. Go to **Security** > **API Shield** > **Settings**.
21+
3. Under **Create a developer portal**, select **Create site**.
22+
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
23+
:::note
24+
If you do not have a schema to upload or to select from a pre-existing schema, export your Endpoint Management schema. For best results, include the learned parameters.
25+
26+
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
27+
:::
28+
5. Select **Download project files** to save a local copy of the files that will be uploaded to Cloudflare Pages. Downloading the project files can be helpful if you wish to modify the project in any way and then upload the new version manually to Pages.
29+
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
30+
7. Select **Deploy site**.
31+
</Steps>
32+
</TabItem>
33+
<TabItem label="New dashboard" icon="rocket">
34+
<Steps>
35+
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
36+
2. Go to **Security** > **Settings**
37+
3. Filter by **API abuse**.
38+
4. On **Create a developer portal**, select **Create site**.
39+
4. Upload an OpenAPI v3.0 schema file or choose to select an existing schema from API Shield.
40+
:::note
41+
If you do not have a schema to upload or to select from a pre-existing schema, export your Endpoint Management schema. For best results, include the learned parameters.
42+
43+
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
44+
:::
45+
5. Select **Download project files** to save a local copy of the files that will be uploaded to Cloudflare Pages. Downloading the project files can be helpful if you wish to modify the project in any way and then upload the new version manually to Pages.
46+
6. Select **Create pages project** to begin project creation. A new Pages project will be automatically created and your API schema will be automatically uploaded to the project along with other supporting static content.
47+
7. Select **Deploy site**.
48+
</Steps>
49+
</TabItem>
50+
</Tabs>
3051

3152
### Custom domains
3253

0 commit comments

Comments
 (0)