{"id":24493094,"url":"https://github.com/open-node/open-rest-docs","last_synced_at":"2026-02-07T10:02:30.133Z","repository":{"id":74486717,"uuid":"98632204","full_name":"open-node/open-rest-docs","owner":"open-node","description":null,"archived":false,"fork":false,"pushed_at":"2017-07-31T17:10:35.000Z","size":29,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-20T01:59:12.578Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-node.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-28T09:14:48.000Z","updated_at":"2017-07-30T04:56:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"fd7625ca-dff2-497d-912a-ecfb4d527c10","html_url":"https://github.com/open-node/open-rest-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/open-node/open-rest-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-node%2Fopen-rest-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-node%2Fopen-rest-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-node%2Fopen-rest-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-node%2Fopen-rest-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-node","download_url":"https://codeload.github.com/open-node/open-rest-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-node%2Fopen-rest-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29191991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T07:37:03.739Z","status":"ssl_error","status_checked_at":"2026-02-07T07:37:03.029Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-21T19:19:04.181Z","updated_at":"2026-02-07T10:02:30.114Z","avatar_url":"https://github.com/open-node.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# open-rest 手册\n\n\u003e 基于 [restify](https://github.com/restify/node-restify) 快速实现的标准 restful api\n\n[![Build status](https://api.travis-ci.org/open-node/open-rest.svg?branch=master)](https://travis-ci.org/open-node/open-rest)\n[![codecov](https://codecov.io/gh/open-node/open-rest/branch/master/graph/badge.svg)](https://codecov.io/gh/open-node/open-rest)\n[![NPM version](https://img.shields.io/npm/v/open-rest.svg?style=flat-square)](https://www.npmjs.com/package/open-rest)\n\n\n### 环境要求\n------------------------------\n\u003e Node.js version 6 以上，最好直接使用 Node.js 8 这样可以放心的使用 async/await 而不用考虑 babel 转换的事情\n\n\n### 快速开始\n------------------------------\n\u003e 建议使用样本工程直接开始，这样能减少很多工作量\n\n```bash\n// 克隆样本工程\ngit clone git@github.com:open-node/open-rest-es6-boilerplate.git myApp\ncd myApp\n\n// 安装依赖库包\nnpm install\n\n// 安装部署\nnpm run setup\n\n```\n\n\n### 编码规范\n- 按照 eslint-airbnb 风格执行,\n- 仅修改了少数几个规则，具体参考样本工程项目下的 .eslintrc\n\n### 目录结构约定\n------------------------------\n\u003cpre\u003e\n├── app\n│   ├── configs // 存放配置信息，里面会根据 NODE_ENV 环境变量自动选择要加载的配置信息\n│   ├── controllers // 控制器\n│   │   └── helper // 提供控制器组装的 helper 功能模块\n│   ├── data // 放一些静态的数据, 比如全国城市的数据\n│   ├── lib // 公共功能模块, 比如转码的，压缩的，加密的等等和业务关系不大的，通用性的函数\n│   ├── locale // 存放 i18n 语言项\n│   ├── middle-wares // 公共中间件，每一个请求都会经过\n│   ├── models // 数据模型\n│   └── routes.js // 路由定义\n├── index.js // api 启动入口\n├── LICENSE\n├── package.json\n└── README.md\n\u003c/pre\u003e\n\n\u003e 注: 项目下新增的目录一定要在目录里放置一个 README.md 用来说明该目录的作用\n\n\n### MIT license\n-------------------------------\n\n* Copyright (c) 2017 open-node\n* Author Redstone Zhao\n* Email: 13740080@qq.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-node%2Fopen-rest-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-node%2Fopen-rest-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-node%2Fopen-rest-docs/lists"}