1. Project Overview

Moyu (Server)

Moyu (Client TypeScript Version)

An API documentation management tool built with Vue and Electron

2. Open Source License

Licensed under MIT

3. Screenshots

Preview

4. Feature Overview

Note: A small number of the features listed below are still under development and improvement. For details, please refer to the README.md documentation.

Main Functions

Team Collaboration

• Login, registration, personal information updates, and password changes
• Fine-grained administrator permission control, down to individual frontend routes and individual backend API endpoints
• Basic API management permissions: administrator, read/write, and read-only permissions
• Batch user import, user account deactivation, and user permission updates
• Custom permissions

API Debugging

• Common HTTP methods, including GET, POST, PUT, DELETE, HEAD, OPTIONS, and others
• Supports debugging RESTful APIs
• Supports query string parameters and body parameters
• Supports form-data, x-www-form-urlencoded, json, xml, text, binary, and other formats
• Supports custom request headers
• Supports variables
• Supports elegant JSON formatting and response data display for multiple MIME types
• Pre-request hooks
• websocket

Left Navigation Menu

• Supports unlimited nesting levels with no limit on the number of APIs
• Supports drag and drop
• Supports batch drag and drop
• Supports right-click context menus for adding, adding from templates, renaming, deleting, and more
• Supports keyboard shortcuts. For example: F2 to rename files, Ctrl + left mouse button to select multiple items, and Ctrl + mouse hover to display details
• Supports batch deletion
• Supports API duplication
• Supports folder duplication
• Supports automatically expanding the navigation menu in sync with Tab navigation
• Supports navigation menu sorting
• Supports searching by URL and document name
• Supports advanced filtering by operator, document date range, most recent N records, and document tags
• Supports width adjustment

Quick Actions in the Left Navigation Bar

• Create New File
• Create New Folder
• Export Documentation
• Generate Online Link
• Refresh Navigation Data
• Preview Document
• Import Document
• History record
• Project Settings
• Recycle Bin
• Customize Quick Access Toolbar

Top Tab Switching

• Supports drag and drop
• Supports right-click context menus
• Supports displaying modification status

API Entry

• Supports modifying cached data to prevent data loss when changes have not been saved
• Supports creating a single API from a template and selecting a template when adding an API
• Supports batch creation of multiple APIs from templates
• Supports custom variables
• Supports automatic cookie inclusion
• Supports RESTful-style path parameters
• Supports query string parameters (?id=3&name=lee)
• Supports various body parameter types, including form-data, x-www-form-urlencoded, json, xml, and more
• Supports request configuration rules, allowing users to restrict parameter types based on HTTP methods (e.g., restricting POST requests to JSON parameters only)
• Supports displaying any number of response parameter sets (e.g., successful responses and error responses)
• Supports custom request headers
• Supports rich-text notes
• Supports parameter templates. Save commonly used parameters as templates for convenient reuse
• Supports importing parameters in JSON format, automatically including notes when parameters are imported
• Supports intelligent auto-completion. After entering parameters, the system automatically fills in parameter types, notes, values, required status, and other information based on historical records
• Supports API tags, allowing users to define custom tags for easier API management

Operation Audit

• From the creation of a project onward, all operations (API creation, deletion, modification, and retrieval; adding users; copying; moving; importing; exporting; etc.) are included in the audit log
• Comprehensive historical record filtering and intuitive history display
• Complete operation records (who performed which operation and when)
• Unlimited historical record retention
• Restore deleted data
• Roll back API modifications to any previous version
• Compare API data across any versions

Keyboard shortcuts

• Shortcuts for common operations (export documentation, import documentation, generate online links)
• Shortcuts for common actions (add API, save API)
• Customizable shortcuts

Mock Data

• Full Mock.js syntax support
• Quick Mock: Make requests in a real server environment without any configuration
• Custom Enum Mock Values

Third-Party Import

• Supports both append import and overwrite import modes
• Supports importing into any folder within the current project
• Import from Project's Own Documentation
• Import from Postman Format
• Import from Swagger/OpenAPI Format
• Import from YApi Format
• Import from RAP2 Format
• Import from Eolinker Format
• Import from DOClever Format
• Import from cURL Format

Documentation Export

• Supports HTML export, including full export and export of any number of items. Happy Fishing Offline Documentation.html
• Supports JSON export, including full export and export of any number of items. Happy Fishing Offline Data.json
• Export freely within the project. Supports exporting the current project (any number of documents) to any location in any project.
• Supports PDF export.

5. Tech Stack

Main technical stack

• Vue
• Electron
• Egg.js
• ElementUI
• MongoDB

Download the client-side TypeScript source code.