easy-yapi
GitHub |
Issues |
GuideHelp you export API to yapi/postman/markdown - Parse API documents based on javadoc & KDoc & ScalaDoc
- Note: It's possible to generate a comprehensive API document with minimal code modification.
- However, specific requirements might necessitate additional comments/annotations. To minimize code intrusion, you can employ flexible configuration rules tailored to your project's needs.
For more details, refer to the GuideHow to Export API to Yapi/Postman/Markdown: In your project, open the file containing the API
or select the desired file or folder in the IDE's left project file area.
Use the shortcut Alt Shift E (windows) / Ctrl E (mac). Then, select the APIs you want to export, select the export channel Yapi/Markdown/Postman
, and click the [✔] button or press Enter to complete the export.
Note: If the shortcut does not work, check for shortcut conflicts. You can modify the shortcut in Preferences(Settings) > KeyMap.