mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-04 13:07:34 +08:00
doc: adding getting started guide as the quick start guide (#1287)
This commit is contained in:
parent
301cfc76c2
commit
07a714ee36
@ -132,10 +132,9 @@ Steps to install APISIX:
|
||||
sudo apisix start
|
||||
```
|
||||
|
||||
2. try limit count plugin
|
||||
2. Try the getting started guide
|
||||
|
||||
Limit count plugin is a good start to try APISIX,
|
||||
you can follow the [documentation of limit count](doc/plugins/limit-count.md).
|
||||
The getting-started guide is a good way to learn the basics of APISIX. Follow the [getting started guide](doc/getting-started.md).
|
||||
|
||||
Then you can try more [plugins](doc/README.md#plugins).
|
||||
|
||||
|
@ -212,7 +212,7 @@ Use the command below to securely access the endpoint now.
|
||||
curl -i -X GET http://127.0.0.1:9080/get -H "Host: httpbin.org" -H 'apikey: superSecretAPIKey'
|
||||
```
|
||||
|
||||
## Add a prefix to the route (Optional)
|
||||
## Add a prefix to the route
|
||||
|
||||
Now lets say you want to add a prefix (eg: samplePrefix) to the route and do not want to use the `host` header then you can use
|
||||
the proxy rewrite plugin to do it.
|
||||
@ -238,6 +238,15 @@ Now you can invoke the route with the following command:
|
||||
curl -i -X GET http://127.0.0.1:9080/samplePrefix/get?param1=foo¶m2=bar -H 'apikey: superSecretAPIKey'
|
||||
```
|
||||
|
||||
## APISIX Dashboard
|
||||
|
||||
As of now the API calls to the APISIX has been orchestrated by using the Admin API. However, APISIX also provides
|
||||
a web application to perform the similar. The dashboard is available in the following
|
||||
[repository](https://github.com/apache/incubator-apisix). The dashboard is intuitive and you can orchestrate the
|
||||
same route configurations via the dashboard as well.
|
||||
|
||||
![Dashboard](images/dashboard.png)
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
- Make sure the required ports are not being used by other systems/processes (The default ports are: 9080, 9443, 2379).
|
||||
|
BIN
doc/images/dashboard.png
Normal file
BIN
doc/images/dashboard.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 34 KiB |
Loading…
Reference in New Issue
Block a user