# edoc-resource

**Repository Path**: phalex/edoc-resource

## Basic Information

- **Project Name**: edoc-resource
- **Description**: 平台相关下载及更新资源
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-01-14
- **Last Updated**: 2023-03-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# edoc-resource

### 介绍
edoc-resource是由**一文网**（<https://edoc.fun>）提供的资源。
1. edoc-sample是edoc使用的示例代码。
2. edoc-ext是使用edoc开发时的可选jar包，提供校验分组、自定义注解等可选扩展内容。
2. edoc-starter是使用edoc开发时的可选jar包，提供属性与名称关系解释及屏蔽无关内容输出等功能。

### 使用说明
1. edoc-sample

   edoc-sample只是一个示例应用，方便用户熟悉edoc的使用方法。将源码克隆到本地，再根据场景需要做如下处理即可。
- 接口测试验证

  本地启动edoc-sample的服务，使用账号（可使用edoc提供的`试用账号`：**sp-maintain / Z45eY&eD0c** ）登录一文网（<https://edoc.fun>），
  分别点击：协作应用-查看文档，点击左侧的一个接口，点击send按钮进行接口测试。
  默认连接的服务地址为http://127.0.0.1:9001，如果变更端口需要先在编辑应用功能中进行维护。
- 接口文档发布验证

  需要先修改edoc-sample源码（文档相关内容即可，与具体实现无关），然后下载edoc客户端，
  点击应用edoc-sample后的发布文档按钮，再根据提示信息进行配置，在文档发布成功后点击查看文档按钮即可（可能需要刷新页面）。
2. edoc-ext

   推荐使用maven进行jar包（相关jar包已经上传到maven中央仓库）引入。
    ```xml
    <dependency>
        <groupId>fun.edoc</groupId>
        <artifactId>edoc-ext</artifactId>
        <version>1.0</version>
    </dependency>
    ```
   也支持jar包的离线下载和源码本地编译打包方式进行引入。
3. edoc-starter

   推荐使用maven进行jar包（相关jar包已经上传到maven中央仓库）引入。
    ```xml
    <dependency>
        <groupId>fun.edoc</groupId>
        <artifactId>edoc-starter</artifactId>
        <version>1.0.1</version>
    </dependency>
    ```
   也支持jar包的离线下载和源码本地编译打包方式进行引入。

### 一文网
一文网（<https://edoc.fun>）是一个java接口文档管理平台。
- 包含网站和客户端两部分。
- 服务有javadoc抽取，api文档查看，api测试。
- 理念是接口文档与代码一起维护，不重复编写文档。程序员可以选择不引入三方jar包，只使用标准的javadoc完成接口文档编写。
- 支持多人协作并提供多种协作角色；所有者变更功能可以在人员变动时做出快速响应。

#### 网站
即一文网，是一个会员制的网站。用户可以免费注册，根据会员等级不同拥有不同的权益。
核心功能如下：
- 创建应用：创建人即应用所有者，对该应用拥有所有权限。
- 开启协作：开启应用协作后，可允许其他成员参与该应用接口文档的维护和使用。
- 成员管理：管理应用协作成员的添加和删除、指定成员的参与角色。
- 查看文档：查看应用的接口文档定义，可以根据接口名称、地址等信息进行快速搜索，不要求启动本地服务。
- 接口测试：需要存在至少一个接口服务，根据需要选择某个接口服务，以类似于postman的方式进行接口测试，接口地址、参数等信息系统会根据抽取到的javadoc注释内容进行自动填充。

#### 客户端
即edoc客户端，在官网上有提供下载。
核心功能如下：
- 全局设置：对数据存储目录等信息进行设置。
- 应用配置：配置应用的一些本地信息，比如：应用源码的位置，为了从源码中抽取javadoc注释。
- 发布文档：即将本地的javadoc注释发布到网站上。
- 查看日志：发布文档过程中出现错误时可以查看。