kayx23 commented on code in PR #13949: URL: https://github.com/apache/apisix/pull/13949#discussion_r4510364767
########## README.md: ########## @@ -68,20 +68,30 @@ APISIX can serve as an **[AI Gateway](https://apisix.apache.org/ai-gateway/)** t APISIX also provides the [`mcp-bridge`](https://apisix.apache.org/blog/2025/04/21/host-mcp-server-with-api-gateway/) plugin to seamlessly convert stdio-based MCP servers to scalable HTTP SSE services. ## Get Started Review Comment: The added heading structure does not materially improve the existing concise sequence, and it currently breaks Markdown rendering rules: headings and fenced blocks are missing required blank lines. Please either keep the compact original flow or justify a smaller structural change, then run Markdownlint before updating the PR. ########## README.md: ########## @@ -68,20 +68,30 @@ APISIX can serve as an **[AI Gateway](https://apisix.apache.org/ai-gateway/)** t APISIX also provides the [`mcp-bridge`](https://apisix.apache.org/blog/2025/04/21/host-mcp-server-with-api-gateway/) plugin to seamlessly convert stdio-based MCP servers to scalable HTTP SSE services. ## Get Started +This guide shows you how to install and run APISIX, create your first route, and send a request through APISIX. -Install and run APISIX with a single command using the quickstart script (requires [Docker](https://docs.docker.com/get-docker/)): +### Prerequisites +Make sure Docker is installed and running on your system. + +### 1. Install and start APISIX + +Run the following command to install and start APISIX using the quickstart script: ```shell curl -sL https://run.api7.ai/apisix/quickstart | sh ``` -This starts APISIX (listening on port `9080`) together with its etcd configuration store. Verify it is running: +The quickstart script starts APISIX on port 9080 and its etcd configuration store. +### 2. Verify that APISIX is running + +Send a request to APISIX on port 9080: ```shell curl "http://127.0.0.1:9080"; --head | grep Server ``` -Create your first route via the Admin API (port `9180`) to proxy requests to an upstream service: +### 3. Create your first route +Create a route using the APISIX Admin API on port 9180. This route forwards requests from /get to the httpbin.org upstream service: Review Comment: Keep literal values formatted as code: `9180`, `/get`, and `httpbin.org`. The patch similarly removes code formatting from `9080`. These are copy-sensitive ports, paths, and hostnames, so presenting them as ordinary prose makes the instructions harder to scan. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
