juzhiyuan commented on a change in pull request #3941: URL: https://github.com/apache/apisix/pull/3941#discussion_r604087119
########## File path: docs/en/latest/getting-started.md ########## @@ -21,247 +21,275 @@ title: Getting Started # --> -## Quick Start Guide +## Getting Started -The goal of this guide is to get started with APISIX and to configure a secured public API with APISIX. -By the end of this guide, you will have a working APISIX setup and a new service which will route to a public API, which is secured by an API key. +This guide aims to get started with Apache APISIX, we will configure the service that will route to a public API, secured by an API key. -The following GET endpoint will be used for the purpose of this tutorial. This will act as an echo endpoint and will return the parameters which are sent to the API. +Also, we will take the following `echo` endpoint as an example, it will return parameters we passed. + +**Request** ```bash $ curl --location --request GET "https://httpbin.org/get?foo1=bar1&foo2=bar2"; ``` -Let's deconstruct the above URL. +**Response** + +```json +{ + "args": { + "foo1": "bar1", + "foo2": "bar2" + }, + "headers": { + "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.9", + "Accept-Encoding": "gzip, deflate, br", + "Accept-Language": "en,zh-CN;q=0.9,zh;q=0.8", + "Cache-Control": "max-age=0", + "Host": "httpbin.org", + "Sec-Ch-Ua": "\"Google Chrome\";v=\"89\", \"Chromium\";v=\"89\", \";Not A Brand\";v=\"99\"", + "Sec-Ch-Ua-Mobile": "?0", + "Sec-Fetch-Dest": "document", + "Sec-Fetch-Mode": "navigate", + "Sec-Fetch-Site": "none", + "Sec-Fetch-User": "?1", + "Upgrade-Insecure-Requests": "1", + "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36", + "X-Amzn-Trace-Id": "Root=1-606276ab-2b451d4b36057c186d666351" + }, + "origin": "58.152.81.42", + "url": "https://httpbin.org/get?foo1=bar1&foo2=bar2"; +} +``` + + +Let's deconstruct the above Request URL. -- Scheme: HTTPS -- Host/Address: httpbin.org +- Protocol: HTTPS - Port: 443 -- URI: /get +- Host: `httpbin.org` +- URI/Path: `/get` - Query Parameters: foo1, foo2 ## Prerequisites -- This guide uses docker and docker-compose to setup APISIX. But if you have already installed APISIX in other ways, you can just skip to [step 2](getting-started.md#step-2-create-a-route-in-apisix). -- Curl: The guide uses curl command for API testing, but you can also use any other tool of your choice (Eg- Postman). +> If you have installed the Apache APISIX, feel free and skip to [Step 2](#step-2-create-a-route) please. + +- This guide uses [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) to setup Apache APISIX. +- `curl`: This guide uses the [curl](https://curl.se/docs/manpage.html) command for API testing, but you can also use any other tools, e.g [Postman](https://www.postman.com/). + +I know you're waiting for this moment for a while, let's go! -## Step 1: Install APISIX +## Step 1: Install Apache APISIX -APISIX is available to install in multiple operating environments. The [following document](how-to-build.md#installation-via-source-release) shows the installation steps in multiple platforms. -For the quick start let's use the docker based set up. To start the APISIX server, clone the following [repository](https://github.com/apache/apisix-docker) and navigate to the example folder and execute the following commands. +<!-- We could follow [Install with Source Release Guide](how-to-build.md#installation-via-source-release) to install the Apache APISIX in multiple operating environments. --> Review comment: oh! just deleted. -- 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. For queries about this service, please contact Infrastructure at: [email protected]
