Expand API Platform Gateway getting started with Try-out, versions, auth, and screenshots

[YasasRangika]

This pull request updates the API Platform Gateway getting started guide to clarify gateway version configuration and significantly improve the API testing instructions. The changes provide clearer guidance on configuring gateway versions, explain authentication mechanisms in detail, and offer practical cURL examples for different security policies.

Gateway version configuration:

• Added documentation on how to configure multiple gateway package versions by editing the [apim.platform_gateway] section in deployment.toml, with instructions on how these appear in the UI when adding or editing a platform gateway.

API testing and authentication:

• Rewrote the "Test the API" section to explain how authentication is enforced via Policy Hub policies, how to identify required auth types in the Dev Portal, and how to set custom API key header names in policies.
• Added step-by-step cURL examples for invoking APIs with no authentication, with API key (including custom header names), with bearer tokens, and with HTTP Basic authentication, aligning the examples with policy configuration and the generated cURL in the Dev Portal.
• Provided troubleshooting tips for authentication failures and clarified the link between policy configuration, deployment, and API invocation.
• Updated info boxes and cross-references to direct users to relevant policy management documentation and Policy Hub resources.

Update Doc Screenshot:

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 78f1f07e-43e8-478d-b017-659d1aa4b4d4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}