Feature: Open API specification for Admin API

[sshniro]

Issue description

Is there an Open API (Swagger) specification to admin API? If so it can be easily used to define and maintain APIs, generate API docs and import in API testing tools like the postman.

[membphis]

We do not have it now. Any good suggestions?

[sshniro]

Okay, shall I start creating an Open API specification for Admin API? After the YAML file is generated, we can use:

1. Redoc This is interactive, we can connect the demo sandbox API SIX environment for this.
2. Slate

Both can be used to show example invocations and autogenerate code for multiple languages.

[membphis]

I'm not very good at this, we can listen to other people's opinions.

Their licenses are friendly, it's very nice.

[moonming]

I tried both, I prefer the Reddoc. @sshniro What do you think?

[sshniro]

@moonming yea I agree, as Admin API has comparatively less APIs Redoc will be good. Slate will be ideal if there are a lot of high-level documents to be written (API Orchestration examples).

[moonming]

@sshniro do you want to add Redoc for Apache APISIX?

[sshniro]

Yes @moonming I would like to initially add the open API specs, but currently working with the HTTP logger. After that, I can start working on this issue.

[membphis]

@sshniro can we close this issue now?

[sshniro]

I did not have time to check on this feature, will try this after merging the docs with the website.

[spacewander]

Since we plan to use manager API to replace admin API, there is no need to investigate into the old one.