Hi,
Another solution would be to use something like Swagger UI
<https://swagger.io/tools/swagger-ui/> for interactive API documentation.
I suggest this because I saw a proposal to move to the Open API spec
with Swagger. Swagger can automatically generate docs from code and it
will be easy to maintain as we will only have a single source of truth.
Users can spin up APISIX in their machines and navigate to an endpoint
say http://address-of-apisix/api/docs to access the Swagger UI and
interactively test the API.
This would make it easy to learn about the API in a hands-on fashion.
Does using something like Postman have much better benefits than just
documenting the APIs? Would we need to maintain this in Postman manually?
- Navendu
On 25/02/22 11:52 am, Yong Qian wrote:
Hello Everyone,
APISIX provides a standard REST API for operating the gateway
configuration. New users can follow the sample API request given in
the documentation to experience how to use APISIX Admin API for the
first time.
And currently our documentation mainly uses curl for API request demo,
do we consider maintaining a public Admin API workshop on a relatively
large API management platform to reduce the cost of hand-on the Admin
API for users?
Just like there are developers (not official) who maintain the
workspace on Postman about the GitHub
API(https://www.postman.com/api-evangelist/workspace/github/overview)
or Kong
API(https://www.postman.com/apievangelist/workspace/kong/api/c8018738-feca-4c90-9372-f4e7c8b00150).
I am not sure if this is in line with the rules of the open source
community, and one might consider this proposal with caution.
