https://github.com/dataman-cloud/omega-api-docs
shurenyun.com api repo
https://github.com/dataman-cloud/omega-api-docs
Last synced: 3 months ago
JSON representation
shurenyun.com api repo
- Host: GitHub
- URL: https://github.com/dataman-cloud/omega-api-docs
- Owner: Dataman-Cloud
- License: apache-2.0
- Created: 2015-11-23T06:40:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-08-16T03:09:07.000Z (almost 9 years ago)
- Last Synced: 2025-01-07T21:43:42.402Z (5 months ago)
- Language: JavaScript
- Homepage: http://apidoc.shurenyun.com/
- Size: 554 KB
- Stars: 1
- Watchers: 42
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 数人云API公开文档仓库
## edit your api doc quickly
1. 访问 http://editor.swagger.io/
2. 用 [master 分支文档](./api-doc.yaml) 里面的内容替换掉 editor.swagger.io 的右侧内容。
3. 开始编辑, 下面参考文档有语法及相应的例子。
4. 由于是线上编辑器，建议更改完内容后尽快保存，以免内容丢失。
5. 文档编写请参考 [数人云RESTful API 文档规范(v0.0.0.1)](./SRY-API-SPEC.md)
## 本地初始化一个文档编辑环境，如果你不想在远程编辑
如果你想在本地起一套编辑环境，及展示站点，你可以
执行下述 bash 命令
```bash
dao pull mydock/swagger-editor
dao pull schickling/swagger-ui
docker run -p 8081:8080 --name=apieditor -d mydock/swagger-editor
docker run -p 80:80 --name=apidoc -e API_URL=https://raw.githubusercontent.com/Dataman-Cloud/omega-api-docs/master/api-doc.json -d schickling/swagger-ui
```
访问 http://$DOCKER_HOST:8081 就会来到编辑页面。
访问 http://$DOCKER_HOST:80 就会看到当前主分支上的doc。
如果想测试开发环境的API,需要以下步骤:
1. 更改api-doc.json的配置:
* "hosts":"forward.shurenyun.com"改为开发环境的域名或者ip.
* schemes字段中的https改为http.
2. $docker cp /absolute_path/api-doc.json apidoc:/app/
3. 如果获取token异常，页面显示 “no response from server”，请进入容器docker exec -it apidoc sh 修改 vi /etc/hosts ，增加开发环境域名或者ip.
如果想更改api doc的描述，则需要更改api-doc.json中的相关配置。此时推荐将apidoc:/app/中的api-doc.json文件与主机的api-doc.json文件共享。
具体做法为：
1. $docker rm -f apidoc
2. $docker run -p 80:80 --name=apidoc -v /absolute_dir/api-doc_dir/:/app/api-doc_dir/ -e API_URL=http://xx.xx.xx.xx/api-doc_dir/api-doc.json -d schickling/swagger-ui
这里api-doc_dir为包含api-doc.json的目录
## references
1. 语法及可用的数据类型: https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md
2. 一个例子: http://petstore.swagger.io/