diff --git a/README.md b/README.md index 1026fe8f8..b8f5d3170 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,9 @@ -## [文档](https://code.simcu.com/jumpserver/jumpserver/tree/master/docs) \ No newline at end of file +## [文档和规范] + +## [项目结构描述](/jumpserver/jumpserver/blob/master/docs/project_structure.md) +## [Python代码规范](/jumpserver/jumpserver/blob/master/docs/python_style_guide.md) +## [API设计规范](/jumpserver/jumpserver/blob/master/docs/api_style_guide.md) + diff --git a/docs/README.md b/docs/README.md index 4ee418c76..8f1ba473d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,2 +1,2 @@ -## [代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/code_style.md) -## [项目结构](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md) +## [代码规范](/jumpserver/jumpserver/blob/master/docs/code_style.md) +## [项目结构](/jumpserver/jumpserver/blob/master/docs/project_structure.md) diff --git a/docs/api_style_guide.md b/docs/api_style_guide.md index 1bdc8a4cc..67a8c790a 100644 --- a/docs/api_style_guide.md +++ b/docs/api_style_guide.md @@ -1,6 +1,10 @@ ## REST API规范约定 -这里仅考虑REST API的基本情况。 +这里仅考虑REST API的基本情况。参考 + +[RESTful API 设计指南](http://www.ruanyifeng.com/blog/2014/05/restful_api.html) + +[github api文档](https://developer.github.com/v3/) ### 协议