You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2020/02/21 07:56:25 UTC
[GitHub] [incubator-apisix] sshniro opened a new issue #1146: Feature: Open
API specification for Admin API
sshniro opened a new issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146
### 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](https://github.com/slatedocs/slate) and import in API testing tools like the postman.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] sshniro commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
sshniro commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-591286310
@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).
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] sshniro commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
sshniro commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-598011153
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.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] sshniro commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
sshniro commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-589631942
Okay, shall I start creating an Open API for Admin API? After the YAML file is generated, we can use:
1. [Redoc](https://github.com/Redocly/redoc) This is interactive, we can connect the demo sandbox API SIX environment for this.
2. [Slate](https://github.com/slatedocs/slate)
Both can be used to show example invocations and autogenerate code for multiple languages.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] moonming commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
moonming commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-590160059
I tried both, I prefer the Reddoc. @sshniro What do you think?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] sshniro edited a comment on issue #1146:
Feature: Open API specification for Admin API
Posted by GitBox <gi...@apache.org>.
sshniro edited a comment on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-589631942
Okay, shall I start creating an Open API specification for Admin API? After the YAML file is generated, we can use:
1. [Redoc](https://github.com/Redocly/redoc) This is interactive, we can connect the demo sandbox API SIX environment for this.
2. [Slate](https://github.com/slatedocs/slate)
Both can be used to show example invocations and autogenerate code for multiple languages.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] membphis commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
membphis commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-589643767
I'm not very good at this, we can listen to other people's opinions.
Their licenses are friendly, it's very nice.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [apisix] sshniro commented on issue #1146: Feature: Open API specification for Admin API
Posted by GitBox <gi...@apache.org>.
sshniro commented on issue #1146:
URL: https://github.com/apache/apisix/issues/1146#issuecomment-673671157
I did not have time to check on this feature, will try this after merging the docs with the website.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] spacewander commented on issue #1146: Feature: Open API specification for Admin API
Posted by GitBox <gi...@apache.org>.
spacewander commented on issue #1146:
URL: https://github.com/apache/apisix/issues/1146#issuecomment-749301109
Since we plan to use manager API to replace admin API, there is no need to investigate into the old one.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [apisix] spacewander closed issue #1146: Feature: Open API specification for Admin API
Posted by GitBox <gi...@apache.org>.
spacewander closed issue #1146:
URL: https://github.com/apache/apisix/issues/1146
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [incubator-apisix] membphis commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
membphis commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-589608853
We do not have it now. Any good suggestions?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] moonming commented on issue #1146: Feature: Open
API specification for Admin API
Posted by GitBox <gi...@apache.org>.
moonming commented on issue #1146: Feature: Open API specification for Admin API
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-597970652
@sshniro do you want to add Redoc for Apache APISIX?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [incubator-apisix] membphis commented on issue #1146: Feature: Open API specification for Admin API
Posted by GitBox <gi...@apache.org>.
membphis commented on issue #1146:
URL: https://github.com/apache/incubator-apisix/issues/1146#issuecomment-652428160
@sshniro can we close this issue now?
----------------------------------------------------------------
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:
users@infra.apache.org