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: app/_how-tos/package-apis-with-dev-portal.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ tldr:
28
28
1. Create an API and attach an OpenAPI spec. Operations from your API's OpenAPI spec should overlap with Routes to ensure requests will be routed to the correct Service. Gateway routing configuration isn't directly modified by adding operations.
29
29
1. Link a control plane to allow developer consumption.
30
30
1. Apply the Access Control Enforcement (ACE) plugin globally.
31
-
1. Create an API package by adding operations and package rate limits. Operations are automatically mapped to Routes using your API's OpenAPI spec or you can create them manually. The Gateway configuration isn't directly modified– any unmatched operations will be highlighted to indicate that a user Gateway Manager permissions needs to perform an action.
31
+
1. Create an API package by adding operations and package rate limits. Operations are automatically mapped to Routes using your API's OpenAPI spec. The Gateway configuration isn't directly modified– any unmatched operations will be highlighted to indicate that a user needs Gateway Manager permissions needs to perform an action.
32
32
prereqs:
33
33
inline:
34
34
- title: "{{site.konnect_short_name}} roles"
@@ -54,6 +54,7 @@ prereqs:
54
54
For this tutorial, you’ll need {{site.base_gateway}} entities, like Gateway Services and Routes, pre-configured. These entities are essential for {{site.base_gateway}} to function but installing them isn’t the focus of this guide.
55
55
56
56
1. Run the following command:
57
+
57
58
```yaml
58
59
echo '
59
60
_format_version: "3.0"
@@ -256,7 +257,7 @@ cleanup:
256
257
icon_url: /assets/icons/gateway.svg
257
258
---
258
259
259
-
You can compose API packages from existing APIs in Dev Portal. API packages allow you to:
260
+
You can compose [API packages](/dev-portal/api-packaging/) from existing APIs in Dev Portal. API packages allow you to:
260
261
* Create distinct APIs for specific use cases or partners based on existing API operations.
261
262
* Link to multiple Gateway Services and/or Routes for developer self-service and application registration.
262
263
* Apply rate limiting policies to an API Package, or per operation.
@@ -282,7 +283,7 @@ To allow developers to consume your API, you must first link an API Gateway and
282
283
283
284
## Assign operations to API packages
284
285
285
-
Now, you can create an API package by picking operations from your API.
286
+
Now, you can create an API package by picking operations from your API. Operations are automatically mapped to Routes using your API's OpenAPI spec. The Gateway configuration isn't directly modified– any unmatched operations will be highlighted to indicate that a user needs Gateway Manager permissions needs to perform an action.
286
287
287
288
1. In the {{site.konnect_short_name}} sidebar, click **Catalog**.
288
289
1. Click the **API packages** tab.
@@ -307,7 +308,7 @@ Now, you can create an API package by picking operations from your API.
307
308
1. Click the **API packages** tab.
308
309
1. Click **Company package**.
309
310
1. Click **Publish API**.
310
-
1. From the **Portal** dropdown menu, select "test".
311
+
1. From the **Portal** dropdown menu, select your Dev Portal.
311
312
1. From the **Authentication strategy** dropdown menu, select "Disabled".
312
313
1. Click **Public**.
313
314
1. Click **Publish API**.
@@ -316,4 +317,4 @@ Your API package will now be published to your Dev Portal. Published API package
316
317
317
318
## Validate
318
319
319
-
Now that you've published your API package, you can verify that it was successfully published to your Dev Portal's URL.
320
+
Now that you've published your API package, you can verify that it was successfully published by navigating to your Dev Portal's URL. You can find your Dev Portal's URL by navigating to the [Dev Portal overview](https://cloud.konghq.com/portals/) in the {{site.konnect_short_name}} UI.
For this tutorial, you’ll need a Dev Portal pre-configured. If you don't have these settings already configured, follow these steps to pre-configure it:
2
2
3
3
1. In the {{site.konnect_short_name}} sidebar, click **Dev Portal**.
4
-
1. Click **New portal** to [create a Dev Portal](https://cloud.konghq.com/portals/create).
0 commit comments