# restdoc

**Repository Path**: mirrors/restdoc

## Basic Information

- **Project Name**: restdoc
- **Description**: restdoc 是基于gin和angular的开源API文档管理工具，前端部分/后端部分见 https://github.com/restdoc/restdoc-server 
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://www.oschina.net/p/restdoc
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2023-02-14
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# restdoc

## 关于

    基于gin和angular的开源的API文档管理工具 前端部分 （功能还在完善中
    
## 安装依赖

    npm i 



## 运行

    如果只是需要使用，不需要调试，可以运行服务端项目 https://github.com/restdoc/restdoc-server
    默认端口 8803

    restdoc-server项目已经包含编译后的前端文件，可以直接运行。如果需要调试前端，可以运行restdoc-server之后再执行以下命令运行前端。

    ng serve --live-reload --port=4208
    
    访问 http://127.0.0.1:4208
    
## 预览

![Image text](https://github.com/restdoc/restdoc/raw/main/src/assets/images/demo2.png)