Skip to main content

Documentation drives developing.

Project description

# Xdocs

RESTful API documents for humans

  • mock server based on python

  • document client based on javascript

  • auto generate test codes

## Getting Started

`bash pip install xdocs xdocs new tutorial cd tutorial xdocs run `

## Feature Support

  1. 文档生成网页(js解析)

  2. 文档静态部署

  3. 在线模拟请求

  4. 复制请求模版(各种语言流行请求库)

  5. 生成测试代码

  6. 生成模拟数据服务器(可独立部署)

  7. 统计接口实现率

  8. 文档编辑热更新

## TODO

  1. 设计文档结构

  2. 设计文档内容规范

  3. 实现根据文档翻译为HTML

  4. 实现根据文档生成mock数据接口

  5. 权限与认证写法设计

## Final Thoughts

1. 文档驱动开发 1. 前后端彻底分离开发 2. 提高开发质量 3. 提升开发速度 4. 加快交付过程

## License

Xdocs is released under the [MIT license](LICENSE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xdocs-0.1.9.tar.gz (44.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page