docs: clarify quickstart admin endpoints

[asim48-ctrl]

Summary

• clarify that /aisix/admin is the Admin API prefix, not a standalone browsable endpoint
• point quickstart users to /openapi and concrete admin resources
• mention localhost/HTTPS access for the Admin UI so browser Web Crypto APIs are available

Context

This follows the confusion reported in #95 around the quickstart output, the Admin API path returning 404 when called directly, and the Admin UI behavior outside localhost/HTTPS.

Validation

• git diff --check
• docs/script text-only change; no Docker runtime required

Summary by CodeRabbit

• Documentation
  • Clarified Admin API setup instructions in Quick Start guides with explicit endpoint paths and resource examples (e.g., models, API keys).
  • Added guidance on accessing interactive API documentation and Admin UI.
  • Included browser compatibility notes regarding HTTPS and localhost requirements for Web Crypto support.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1041e25c-ca94-4a96-910a-9170bc8f9a57

📥 Commits

Reviewing files that changed from the base of the PR and between b6e0b15 and 96d908d.

📒 Files selected for processing (3)

• README.md
• docs/getting-started/quick-start.md
• quickstart/quickstart.sh

---

📝 Walkthrough

Walkthrough

This PR updates user-facing documentation and quickstart script output to clarify that the Admin API endpoint is a URL prefix requiring specific resource paths. It directs users to /openapi for interactive API documentation, provides concrete example paths, and specifies origin requirements for browser Crypto API access.

Changes

Admin API Usage Clarification

Layer / File(s)

Summary

Admin API prefix guidance and usage examples README.md, docs/getting-started/quick-start.md, quickstart/quickstart.sh

README Quick Start and getting-started guide now clarify that the Admin API is a URL prefix (not a standalone page), direct users to /openapi for interactive docs, suggest concrete resource paths (/aisix/admin/models, /aisix/admin/apikeys), and specify that the Admin UI requires 127.0.0.1, localhost, or HTTPS origin. Quickstart script output updated to match these clarifications and add example resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• api7/aisix#105: Introduced the quickstart/quickstart.sh script and Admin API endpoint expectations; this PR clarifies those endpoints in user documentation.
• api7/aisix#131: Modifies overlapping getting-started and Admin API usage guidance to teach users how to reach Admin endpoints and UI in the Quick Start flow.

✨ 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.}