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

## Getting Started

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

## Feature Support

  1. yml语法编写接口文档

  2. 文档写法符合RESTful的要求

  3. 自动生成优雅的web页面

  4. 自动生成mock数据服务器

  5. 文档修改热更新

## TODO

  1. 设计文档结构

  2. 设计文档内容规范

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

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

## Final Thoughts

文档驱动开发

## 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.8.tar.gz (44.0 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