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;
   3. API can be linked with selector/rule/meta_data;
   4. Applications can use `shenyu-client-api-doc` to generate and import API 
docs;
   5. Initiate a mock request in admin;
   
   The following is the UML design diagram of the database:
   
![shenyu-api-doc-table](https://user-images.githubusercontent.com/38336731/206841985-47aa0c01-f4a5-4e3a-8846-475cd892271d.png)
   
   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);
   - [ ] 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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to