# API Format

**Repository Path**: papertiger8848/API-Format

## Basic Information

- **Project Name**: API Format
- **Description**: 一个快速的RESTful API编写和美化工具，完全基于JS，不需要服务器环境也能运行！
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2014-05-15
- **Last Updated**: 2021-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#API Format

这是一个快速编写漂亮的RESTful风格API的工具。
提供一种易读的易维护的构造方式

## DEMO
DEMO 地址 http://panshihao.cn/apiformat/api.html

## 安装
### 1.将所有的源码git到本地，项目本身使用 Intellij idea编写的，不过这是一个纯JS+HTML的项目你可以使用任意工具来编辑。
### 2.直接运行 api.html 就可以看到效果了
### 3.如果打开 api.html后无法看到效果，多半的情况是使用了不允许跨域的浏览器，那么你只要将相关的文件扔到任意的WEB环境下再访问 api.html就可以了。

## 使用
### 1.apiformat所有的内容都来源于api.txt中，通过api.js对于api.txt的解析，将内容构造到api.html中
### 2.api.txt使用了一种类似于 markdown和api blueprint的格式，很好理解，具体的操作手册稍候会增加上来。其实api.txt中已经有不少的demo数据了，看一下就明白了。

## 更新
请使用邮件与我联系 312451824@qq.com
工具的更新时间不固定~~~