Apisix-dashboard: docs: API document about `Manager-API`

Created on 7 Dec 2020  路  8Comments  路  Source: apache/apisix-dashboard

The API interfaces of Manager API and Admin API are mostly the same.

However, the Manager API actually adds some new APIs, such as the search interface for Dashboard.

We need a separate documentation page to list the API interfaces that the Manager API implements separately.

backend documentation

Most helpful comment

we need swagger to manager those APIs

All 8 comments

@nic-chen Do you have time to check this issue?

@membphis
Here is the list:

|Method |Request URI|Request Body|Description |
|---------|-------------------------|--|------|
|GET |/apisix/admin/routes?page=&page_size=&name=&uri=|NULL|Fetch route list|
|GET |/apisix/admin/notexist/routes?name=&exclude=|NULL|Check route exists by name|
|GET |/apisix/admin/services?page=&page_size=&name=|NULL|Fetch service list|
|GET |/apisix/admin/upstreams?page=&page_size=&name=|NULL|Fetch upstream list|
|GET |/apisix/admin/ssl?page=&page_size=&sni=|NULL|Fetch SSL list|
|POST |/apisix/admin/check_ssl_cert |{"cert": "xx", "key":"xx"}|verify SSL cert and key|
|POST |/apisix/admin/check_ssl_exists |["a.com", "b.com"]|check SSL exists or not by sni|
|GET |/apisix/admin/consumers?page=&page_size=&username=|NULL|Fetch consumer list|
|POST |/apisix/admin/user/login|{"username":"xx", "password":"xx"}|User login|

we need swagger to manager those APIs

@nic-chen we do not need a full API list. only need some new API different from Admin API.

we need swagger to manager those APIs

OK, It's a better way for api doc.

@nic-chen we do not need a full API list. only need some new API different from Admin API.

updated. I will submit the first PR about api doc with those APIs.

I confirm some detail.

eg, the API /apisix/admin/routes?page=&page_size=&name=&uri=

The API doc should focus on the new argument: page, page_size, name and uri.

@nic-chen all right?

I confirm some detail.

eg, the API /apisix/admin/routes?page=&page_size=&name=&uri=

The API doc should focus on the new argument: page, page_size, name and uri.

@nic-chen all right?

OK

Was this page helpful?
0 / 5 - 0 ratings