https://github.com/cyole/vscode-crabu

A VS Code extension for managing and generating code from YAPI APIs.
https://github.com/cyole/vscode-crabu

vscode-extension yapi

Last synced: 7 months ago
JSON representation

A VS Code extension for managing and generating code from YAPI APIs.

• Host: GitHub
• URL: https://github.com/cyole/vscode-crabu
• Owner: cyole
• License: mit
• Created: 2025-07-26T04:16:17.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-08-02T09:27:01.000Z (7 months ago)
• Last Synced: 2025-08-02T11:41:50.288Z (7 months ago)
• Topics: vscode-extension, yapi
• Language: TypeScript
• Homepage: https://marketplace.visualstudio.com/items?itemName=cyole.crabu
• Size: 494 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Crabu

A VS Code extension for managing and generating code from YAPI APIs.





## Configurations

| Key                        | Description         | Type      | Default                             |

| -------------------------- | ------------------- | --------- | ----------------------------------- |

| `crabu.yapiBaseUrl`        | yapi文档的baseUrl      | `string`  | `""`                                |

| `crabu.yapiProjects`       | yapi项目列表            | `array`   | `[]`                                |

| `crabu.annotations`        | 是否开启接口注解            | `boolean` | `true`                              |

| `crabu.primaryColor`       | 主题色                 | `string`  | `"#9D5BF4"`                         |

| `crabu.crabuServerBaseUrl` | Crabu服务的baseUrl     | `string`  | `"http://localhost/api"`            |

| `crabu.autoAiGenerateMock` | 是否使用AI自动生成Mock数据    | `boolean` | `true`                              |

| `crabu.aiPrompt`           | 使用AI生成Mock数据时的默认提示词 | `string`  | `"图片数据源使用 https://dummyimage.com/"` |

## Commands

| Command                           | Title                                |

| --------------------------------- | ------------------------------------ |

| `crabu.launch`                    | Crabu: Launch Crabu                  |

| `crabu.refreshApiTreeView`        | Crabu: Refresh API Tree View         |

| `crabu.refreshMockTreeView`       | Crabu: Refresh Mock Tree View        |

| `crabu.searchApi`                 | Crabu: Search API                    |

| `crabu.searchApiGroup`            | Crabu: Search API Group              |

| `crabu.showCrabuWebview`          | Crabu: Show Crabu Webview            |

| `crabu.getApiTreeDataUpdateTime`  | Crabu: Get API Tree Data Update Time |

| `crabu.switchMockStatus`          | Crabu: Switch Mock Status            |

| `crabu.addApiToMock`              | Add API to Mock                      |

| `crabu.addApiToMockByUrl`         | Crabu: Add API to Mock by Yapi Url   |

| `crabu.addApiGroupToMock`         | Add API Group to Mock                |

| `crabu.removeFromMock`            | Remove API from Mock                 |

| `crabu.showCrabuWebviewWithMock`  | Show Crabu Webview with Mock         |

| `crabu.updateMockToLatestVersion` | Update Mock to Latest Version        |

| `crabu.genBusinessCode`           | Generate Business Code               |

| `crabu.compareWithLatestVersion`  | Compare with Latest Version          |

| `crabu.copyApiPath`               | Copy API Path                        |

| `crabu.aiGenerateMock`            | AI Generate Mock                     |

| `crabu.updateAiQueueStatus`       | Crabu: Update AI Queue Status        |

| `crabu.findInApi`                 | Crabu: Find in API                   |

| `crabu.findInMock`                | Crabu: Find in Mock                  |

| `crabu.updateCrabuMockStatus`     | Crabu: Update Crabu Mock Status      |

| `crabu.refreshAiQueueTreeView`    | Crabu: Refresh AI Queue Tree View    |

| `crabu.cancelAiTask`              | Cancel AI Task                       |

## License

[MIT](./LICENSE.md) License © 2025 [Cyole](https://github.com/cyole)