You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shenyu.apache.org by "dragon-zhang (via GitHub)" <gi...@apache.org> on 2023/08/03 07:43:47 UTC
[GitHub] [shenyu] dragon-zhang opened a new issue, #4646: [Task] api doc import&export
dragon-zhang opened a new issue, #4646:
URL: https://github.com/apache/shenyu/issues/4646
### Description
Currently, shenyu only supports adding API level descriptions(see `path_desc` in `meta_data` table). In order to improve the functions of shenyu API documents, we need to do a lot of things (see the task list below for detailed tasks).
Expected final effect:
1. Support API import and export of multiple specifications and document formats;
2. Support manual API management in admin; done
3. API can be linked with selector/rule/meta_data; done
4. Applications can use `shenyu-client-api-doc` to generate and import API docs; done
5. Initiate a mock request in admin; done
The following is the UML design diagram of the database:
Generally, there will be no changes, and you can visit [database-design-zh](https://shenyu.apache.org/zh/docs/next/design/database-design) / [database-design-en](https://shenyu.apache.org/docs/next/design/database-design) to see the latest design document of the database.
### Task List
## Stage 4 api doc import&export
- [ ] the backend support open-api/swagger doc import(It needs to support multiple document formats, such as json, md, and html);
- [ ] the backend support yapi doc import(It needs to support multiple document formats, such as json, md, and html);
- [ ] the backend support open-api/swagger doc export(It needs to support multiple document formats, such as json, md, and html); @hsien999
- [ ] the backend support yapi doc export(It needs to support multiple document formats, such as json, md, and html);
- [ ] the front supports import/export API documents;
- [ ] the front supports import/export curl as mock request;
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@shenyu.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shenyu] moremind closed issue #4646: [Task] api doc import&export
Posted by "moremind (via GitHub)" <gi...@apache.org>.
moremind closed issue #4646: [Task] api doc import&export
URL: https://github.com/apache/shenyu/issues/4646
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@shenyu.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [shenyu] hsien999 commented on issue #4646: [Task] api doc import&export
Posted by "hsien999 (via GitHub)" <gi...@apache.org>.
hsien999 commented on issue #4646:
URL: https://github.com/apache/shenyu/issues/4646#issuecomment-1554203364
open-api/swagger doc import & export assign to me
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@shenyu.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Task] api doc import&export [shenyu]
Posted by "yu199195 (via GitHub)" <gi...@apache.org>.
yu199195 closed issue #4646: [Task] api doc import&export
URL: https://github.com/apache/shenyu/issues/4646
--
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.
To unsubscribe, e-mail: notifications-unsubscribe@shenyu.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org